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.

Configuration

todo_include_todos

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

todo_emit_warnings

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

1.5 新版功能.

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

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.