Sphinx-apidocs 不从 python 代码生成 TODO 文档

Question

我设置了 Sphinx api 文档，它从我的 python 代码生成 html 文档。所以唯一缺少的是它没有生成 # TODO 文档。

我检查了不同的网站和 Sphinx api-doc 文档并检查了我的配置，看起来不错。

这是我的配置：

config.py

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
]

todo_include_todos = True

并且在设置快速入门时，

todo: write "todo" entries that can be shown or hidden on build (y/n) [n]: y

以及 .py 文件中的文档

def post(self):
    """
    Adds a :class:`Persona` resource in Persona resource list.

    :returns: A newly created Persona resource with http 201 response code.
    """
    args = parser.parse_args()
    persona_id = int(max(PERSONAS.keys())) + 1
    persona_id = '%i' % persona_id
    PERSONAS[persona_id] = {'name': args['name']}

    # TODO Validate all post fields

    return PERSONAS[persona_id], 201

生成了以上代码文档，但生成的文档中没有# TODO 部分。

Answer 1

Sphinx 不对 # TODO 评论做任何事情。

Sphinx 可以做的是处理用特殊 todo 指令指定的待办事项。它可以包含在文档字符串中：

def post(self):
    """
    Adds a :class:`Persona` resource in Persona resource list.

    :returns: A newly created Persona resource with http 201 response code.

    .. todo::

       Validate all post fields 

    """

Sphinx-apidocs 不从 python 代码生成 TODO 文档

Sphinx-apidocs not generating TODO documentation from python code

python-sphinx