如何让 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.