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

模块作者：Daniel Bültmann

版本 0.5 中新增。

使用此扩展时，还有两个额外的指令

.. todo::¶

使用此指令，例如，note。

它只会在输出中显示，如果todo_include_todos为True。

在版本 1.3.2 中新增: 此指令支持一个class选项，用于确定HTML输出的类属性。如果未给出，则类默认为admonition-todo。

这些可以如下配置。

配置¶

todo_include_todos¶

如果此值为True，则todo和todolist会生成输出，否则它们不生成任何输出。

todo_emit_warnings¶

如果此值为True，则todo会为每个待办事项条目发出警告。

版本 1.5 新增。

todo_link_only¶

如果此值为True，则todolist会生成不带文件路径和行号的输出。

版本 1.4 中新增。

autodoc 提供以下附加事件

todo-defined(app, node)¶: 版本 1.5 新增。

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