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：写＆＃34; todo＆＃34;可以在构建中显示或隐藏的条目（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指令指定的待办事项。它可以包含在docstring：

中

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文档

1 个答案: