Add todo extension.

1 files changed, 30 insertions, 0 deletions

diff --git a/doc/ext/todo.rst b/doc/ext/todo.rst
new file mode 100644
index 00000000..7bc65a02
--- /dev/null
+++ b/doc/ext/todo.rst
@@ -0,0 +1,30 @@
+:mod:`sphinx.ext.todo` -- Support for todo items
+================================================
+
+.. module:: sphinx.ext.todo
+   :synopsis: Allow inserting todo items into documents.
+.. moduleauthor:: Daniel Bültmann
+
+.. versionadded:: 0.5
+
+There are two additional directives when using this extension:
+
+.. directive:: todo
+
+   Use this directive like, for example, :dir:`note`.
+
+   It will only show up in the output if :confval:`todo_include_todos` is true.
+
+
+.. directive:: todolist
+
+   This directive is replaced by a list of all todo directives in the whole
+   documentation, if :confval:`todo_include_todos` is true.
+
+   
+There is also an additional config value:
+   
+.. confval:: todo_include_todos
+
+   If this is ``True``, :dir:`todo` and :dir:`todolist` produce output, else
+   they produce nothing.  The default is ``False``.