Sphinx Doctest没有找到测试

Question

我正在试图找出如何使用Sphinx进行doctest测试，但它似乎没有找到我的测试。我有以下简单的例子。

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块的缩进：

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

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

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