Wie erhalte ich Sphinx Code in Dokumentation eingebettet zu testen?

Question

Wenn dieser Code ist ein Zitat in meiner Dokumentation, was muss ich tun, um Sphinx laufen zu lassen es, wenn die Dokumentation erzeugt wird? Ich habe versucht, das Hinzufügen

.. testcode::

    import datetime
    def today():
        return datetime.datetime.now().date()
    if True:
        today()

zu einem der .rst Quellen und die Sphinx doctest Erweiterung conf.py, aber ich habe einen Fehler über unerwartete Vertiefung beschwert in der ersten Zeile des Funktionskörpers. Ist Sphinx doctest können Funktionen in der Dokumentation definiert laufen?

Answer 1

Die testcode Richtlinie muss eine passende testoutput Richtlinie.

Hier ist das Beispiel aus der Dokumentation.

.. testcode::

   print 'Output     text.'

.. testoutput::
   :hide:
   :options: -ELLIPSIS, +NORMALIZE_WHITESPACE

   Output text.