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

Question

如果此代码是我的文档中的块引用，我需要做什么才能让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.