在sphinx docs

Question

我正在尝试使用todo功能，我在sphinx-docs上找到了一个链接，语法如下

.. todo::

但它说我需要将todo_include_todos设置为True，因为默认情况下它是False，我需要更新哪个文件才能启用？

我发现了另一个SO帖子Sphinx todo box not showing，但我们认为它没有提到我需要设置配置的文件。

Answer 1

sphinx.ext.todo是一个Sphinx扩展程序，可以通过将其添加到conf.py中的扩展程序列表来启用：

extensions = [
    'extname',
    'sphinx.ext.todo',
]

启用后，您需要通过将值todo_include_todos设置为True来配置它，同样在conf.py中：

# Display todos by setting to True
todo_include_todos = True

待办事项的主题支持各不相同。

另见http://www.sphinx-doc.org/en/stable/config.html#confval-extensions

Answer 2

请注意，还可以在命令行上覆盖配置选项，这可以使根据目标受众更快速地公开或隐藏“要做的事情”。我认为在这种情况下，布尔值必须以0或1的形式传递。

sphinx-build -b html -D todo_include_todos=1 -c docs docs build/html

或

python -m sphinx -b html -D todo_include_todos=1 -c docs docs build/html