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
isTrue
.New in version 1.3.2: This directive supports an
class
option that determines the class attribute for HTML output. If not given, the class defaults toadmonition-todo
.
-
.. todolist::
¶ This directive is replaced by a list of all todo directives in the whole documentation, if
todo_include_todos
isTrue
.
There is also an additional config value: