sphinx.ext.todo -- Support for todo items

模組作者：Daniel Bültmann

在 0.5 版被加入.

There are two additional directives when using this extension:

.. todo::

Use this directive like, for example, note.

It will only show up in the output if todo_include_todos is True.

在 1.3.2 版被加入: This directive supports an class option that determines the class attribute for HTML output. If not given, the class defaults to admonition-todo.

.. todolist::

This directive is replaced by a list of all todo directives in the whole documentation, if todo_include_todos is True.

These can be configured as seen below.

組態

todo_include_todos
Type:
bool
預設值:
False

If this is True, todo and todolist produce output, else they produce nothing.

todo_emit_warnings
Type:
bool
預設值:
False

If this is True, todo emits a warning for each TODO entries.

在 1.5 版被加入.

Type:
bool
預設值:
False

If this is True, todolist produce output without file path and line.

在 1.4 版被加入.

autodoc provides the following an additional event:

todo-defined(app, node)

在 1.5 版被加入.

Emitted when a todo is defined. node is the defined sphinx.ext.todo.todo_node node.