Python sphinx Sphinx apidocs未从python代码生成TODO文档
我已经设置了Sphinx api文档,它可以从我的python代码生成html文档。所以唯一缺少的是它没有生成TODO文档 我已经检查了不同的网站和Sphinx api文档,并检查了我的配置,看起来不错 以下是我的配置: config.pyPython sphinx Sphinx apidocs未从python代码生成TODO文档,python-sphinx,Python Sphinx,我已经设置了Sphinx api文档,它可以从我的python代码生成html文档。所以唯一缺少的是它没有生成TODO文档 我已经检查了不同的网站和Sphinx api文档,并检查了我的配置,看起来不错 以下是我的配置: config.py extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', ] todo_include_todos = True 在设置quickstart时 todo:
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
]
todo_include_todos = True
在设置quickstart时
todo:写入可在生成时显示或隐藏的“todo”项(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
注释不做任何操作
Sphinx可以做的是处理用特殊指令指定的todo项。它可以包含在文档字符串中:
def post(self):
"""
在人物角色资源列表中添加:class:`Persona`资源。
:返回:带有http 201响应代码的新创建的角色资源。
…todo::
验证所有post字段
"""
斯芬克斯对#TODO
注释没有任何作用
Sphinx可以做的是处理用特殊指令指定的todo项。它可以包含在文档字符串中:
def post(self):
"""
在人物角色资源列表中添加:class:`Persona`资源。
:返回:带有http 201响应代码的新创建的角色资源。
…todo::
验证所有post字段
"""