Sphinx

`sphinx.ext.todo` --对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_include_todos 是 True .

这些配置如下所示。

配置¶

todo_include_todos¶: 如果这是 True ， todo 和 todolist 产出，否则什么也不产出。默认值为 False .

todo_emit_warnings¶: 如果这是 True ， todo 对每个TODO条目发出警告。默认值为 False .

Added in version 1.5.

todo_link_only¶: 如果这是 True ， todolist 生成不带文件路径和行的输出，默认为 False .

Added in version 1.4.

AutoDoc提供以下附加事件：

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

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