manuel

manuel erlaubt das Testen von Python-Code in einer Sphinx-Dokumentation.

Mit dem Modul manuel.codeblock führt manuel Python-Code in reST- Dokumenten aus, dem .. code-block:: python vorangestellt ist, also z.B.:

.. code-block:: python

    def foo:
        pass

gibt die folgende Fehlermeldung aus:

>>> import manuel.codeblock
>>> m = manuel.codeblock.Manuel()
>>> document.process_with(m, globs={})
  File "<memory>:4", line 2
     def foo:
            ^
SyntaxError: invalid syntax

Falls ein Code-Block in einem reST-Dokument nicht getestet werden soll, kann manuel.ignore verwendet werden. Hierzu wird .. ignore-next-block vor dem Code-Block angegeben, also z.B.

.. ignore-next-block
.. code-block:: python

    def foo:
        pass

Weitere Informationen erhalten Sie in Manuel Documentation.