sphinx.ext.todo -- 支持todo项

模块作者： Daniel Bültmann

在 0.5 版本加入.

使用此插件时会多出两个指令：

.. todo::

此指令用法类似于 note。

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

在 1.3.2 版本加入: 此指令支持用于确定HTML输出的class属性的 class 选项。如果未给定，则该类默认为 adminion-todo。

.. todolist::

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

这些可以按如下做配置。

配置

todo_include_todos
类型:
bool
默认:
False

如果为 True，todo 和 todolist 会生成输出，否则不会生成任何内容。

todo_emit_warnings
类型:
bool
默认:
False

如果为 True，todo 会为每个TODO条目发出警告。

在 1.5 版本加入.

类型:
bool
默认:
False

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

在 1.4 版本加入.

autodoc提供以下附加事件：

todo-defined(app, node)

在 1.5 版本加入.

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