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
Тип:
bool
По умолчанию:
False

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

todo_emit_warnings
Тип:
bool
По умолчанию:
False

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

Добавлено в версии 1.5.

Тип:
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.