Sphinx logo

Previous topic

sphinx.ext.coverage – Collect doc coverage stats

Next topic

sphinx.ext.extlinks – Markup to shorten external links

This Page

sphinx.ext.todo – Support for todo items

Module author: Daniel Bültmann

New in version 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.

.. todolist::

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

There is also an additional config value:

todo_include_todos

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