sphinx.ext.todo – 支持待办事项

模块作者：Daniel Bültmann

0.5 新版功能.

使用此扩展时，还有两个附加指令:

.. todo::

使用此指令，例如， note.

它只会出现在输出中 todo_include_todos 是 True 。

1.3.2 新版功能: 该指令支持 class 选项，该选项确定HTML输出的class属性。如果没有给出，该类默认为 admonition-todo 。

.. todolist::

如果出现以下情况，则该指令将替换为整个文档中所有todo指令的列表 todo_include_todos 为 True 。

这些可以配置如下所示。

配置

todo_include_todos

如果这是 True ，则 todo 和 todolist 产生输出，否则它们什么都不产生。默认为 False 。

todo_emit_warnings

如果这是 True ，则 todo 会为每个TODO条目发出警告。默认为 False 。

1.5 新版功能.

todo_link_only

如果这是 True ，则 todolist 产生没有文件路径和行的输出，默认为 False 。

1.4 新版功能.

autodoc提供以下附加事件:

todo-defined(app, node)

1.5 新版功能.

定义todo时发出。 node 是定义的 sphinx.ext.todo.todo_node 节点。