sphinx.ext.todo – Prise en charge des éléments todo

Auteur du module : Daniel Bültmann

Ajouté dans la version 0.5.

Il existe deux directives supplémentaires quand vous utilisez cette extension :

.. todo::

Utilisez cette directive comme, par exemple, note.

Il n’apparaîtra dans la sortie que si todo_include_todos est True.

Ajouté dans la version 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
Type:
bool
Défaut:
False

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

todo_emit_warnings
Type:
bool
Défaut:
False

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

Ajouté dans la version 1.5.

Type:
bool
Défaut:
False

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

Ajouté dans la version 1.4.

autodoc provides the following an additional event:

todo-defined(app, node)

Ajouté dans la version 1.5.

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