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

Question

如果这段代码是我文档中的一个引用块，我需要怎么做才能让Sphinx在生成文档时运行它? 我尝试添加：

.. testcode::

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

我尝试将.rst源文件和Sphinx doctest扩展添加到conf.py中，但是我收到了一个错误，指出函数体的第一行缩进不正确。Sphinx的doctest能否运行在文档中定义的函数？

- joeforker

---

你读过http://sphinx.pocoo.org/ext/doctest.html吗？基于你所读的内容，你有哪些*具体*问题？ - S.Lott

由于 testblock 不是 Sphinx 指令，我不知道您认为应该发生什么。如果您的意思是 testcode，则缺少 testoutput。如果您的意思是 doctest，则缺少所有预期的标点符号。 - S.Lott

如果测试代码无法运行而没有测试输出，那么这就是一个好答案。 - joeforker

Answer 1

< p > testcode 指令需要与匹配的 testoutput 指令。

以下是文档中的示例。

.. testcode::

   print 'Output     text.'

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

   Output text.

- S.Lott