python - ドキュメントに埋め込まれたコードをSphinxでテストするにはどうすればよいですか？

Question

このコードが私のドキュメントのブロッククォートである場合、ドキュメントが生成されたときにSphinxにそれを実行させるために何をする必要がありますか？追加してみました

.. testcode::

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

ソースの1つと.rstSphinxdoctest拡張機能にconf.py。しかし、関数本体の最初の行に予期しないインデントがあるというエラーが発生しました。Sphinxのdoctestは、ドキュメントで定義されている関数を実行できますか？

Answer 1

testcodeディレクティブには、一致するディレクティブが必要ですtestoutput。

ドキュメントの例を次に示します。

.. testcode::

   print 'Output     text.'

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

   Output text.