：模式：sphinx.ext.todo–支持todo项

模块作者： Daniel Bültmann

Added in version 0.5.

使用此插件时有两个附加指令：

.. todo::

使用以下指令，例如：rst:方向：`注意’。

只有当：confval:`todo_include_todos`为`True``时，它才会显示在输出中。

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

.. todolist::

如果：confval:todo_include_todos`为’`True`，则此指令将替换为整个文档中所有todo指令的列表。

这些配置如下所示。

配置

todo_include_todos

如果这是“真的”：rst:方向：`todo`和：rst:方向：`todolist’产生输出，否则它们什么也不产生。默认值为“False”。

todo_emit_warnings

如果这是“真的”：rst:方向：`todo`为每个todo项发出警告。默认值为“False”。

Added in version 1.5.

todo_link_only

如果这是“真的”：rst:方向：`todolist`生成不带文件路径和行的输出，默认为“False”。

Added in version 1.4.

autodoc提供以下附加事件：

todo-defined(app, node)

Added in version 1.5.

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