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

模块作者：Daniel Bültmann

版本 0.5 中新增。

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

.. todo::¶

例如，使用此指令就像使用 note 一样。

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

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

.. todolist::¶: 如果 todo_include_todos 为 True，则此指令将替换为整个文档中所有 todo 指令的列表。

这些可以像下面看到的那样进行配置。

配置¶

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 中新增。

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