`sphinx.ext.todo` --支持待办事项¶

模块作者： Daniel Bültmann

Added in version 0.5.

使用此扩展时，还有两条附加指令：

.. todo::¶

使用此指令，例如， note 。

只有在以下情况下，它才会显示在输出中 todo_include_todos 是 True 。

Added in version 1.3.2: 此指令支持 class 用于确定HTML输出的类属性的选项。如果未指定，则类默认为 admonition-todo 。

.. todolist::¶: 在以下情况下，此指令将被整个文档中的所有TODO指令的列表所取代 todo_include_todos 是 True 。

这些配置可以如下所示进行配置。

配置¶

todo_include_todos¶

如果这是 True , todo 和 todolist 生产产出，否则他们什么也不生产。

todo_emit_warnings¶

如果这是 True , todo 为每个TODO条目发出警告。

Added in version 1.5.

todo_link_only¶

如果这是 True , todolist 产生不带文件路径和行的输出。

Added in version 1.4.

AutoDoc提供了以下附加事件：

todo-defined(app, node)¶: Added in version 1.5.

在定义待办事项时发出。 node 是已定义的 sphinx.ext.todo.todo_node 节点。