python - Sphinx Doctest 找不到测试

Question

我正在尝试弄清楚如何让 doctest 与 Sphinx 一起工作，但它似乎没有找到我的测试。我有以下简单示例。

def my_func():
    '''
    Dummy test function. Returns the number 5.
    .. doctest::

    >>> my_func()
    5
    '''
    return 5

当我运行 make doctest 时，输出告诉我有零个测试。我很确定我的配置是正确的，因为如果我运行 make html 然后转到我的 index.html 文件，我会看到函数 my_func() 包含在文档。

我是不是忽略了一些简单的东西？感谢您的帮助。

Answer 1

即使它已经在评论中解决了，这里的答案也可以帮助人们访问问题，更容易找到解决方案。

问题是 doctest block 的缩进:

def my_func():
    '''
    Dummy test function. Returns the number 5.
    .. doctest::

        >>> my_func()
        5
    '''
    return 5

只有在 doctest block 之后缩进的行才被认为是测试的一部分并被测试。