如何让Sphinx测试文档中嵌入的代码？

Question

如果此代码是我的文档中的blockquote，那么在生成文档时我需要做些什么来使Sphinx运行它？我尝试添加

.. testcode::

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

到其中一个.rst来源和Sphinx doctest扩展到conf.py，但我收到错误抱怨函数体第一行意外缩进。 Sphinx的doctest是否能够运行文档中定义的函数？

Answer 1

testcode指令需要匹配的testoutput指令。

以下是文档中的示例。

.. testcode::

   print 'Output     text.'

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

   Output text.