`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_include_todos 为 True ,则此指令将被整个文档中的所有待办事项指令的列表所替代.

这些可以按照下面的方式进行配置.

配置¶

todo_include_todos¶: 如果这个值为 True ,则 todo 和 todolist 会生成输出;否则它们将不输出任何内容.默认值为 False .

todo_emit_warnings¶: 如果这个值为 True ,:rst:dir:todo 将为每个 TODO 条目发出警告.默认值为 False .

Added in version 1.5.

todo_link_only¶: 如果这个值为 True ,:rst:dir:todolist 将生成没有文件路径和行号的输出,默认值为 False .

Added in version 1.4.

autodoc 提供以下额外事件:

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

当定义了一个待办事项时发出.*node* 是定义的 sphinx.ext.todo.todo_node 节点.