Add todo extension.

6 files changed, 41 insertions, 4 deletions

diff --git a/doc/conf.py b/doc/conf.py
index ca30ad91..61ff10e2 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -21,7 +21,7 @@ import sys, os, re
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.addons.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -134,6 +134,12 @@ latex_elements = {
 #latex_appendices = []
 
 
+# Extension options
+# -----------------
+
+todo_include_todos = True
+
+
 # Extension interface
 # -------------------
 
diff --git a/doc/ext/builderapi.rst b/doc/ext/builderapi.rst
index fb2b7ea4..adc41016 100644
--- a/doc/ext/builderapi.rst
+++ b/doc/ext/builderapi.rst
@@ -3,7 +3,7 @@
 Writing new builders
 ====================
 
-XXX to be expanded.
+.. todo:: Expand this.
 
 .. currentmodule:: sphinx.builder
 
diff --git a/doc/ext/coverage.rst b/doc/ext/coverage.rst
index 2f1e00ec..13294f8b 100644
--- a/doc/ext/coverage.rst
+++ b/doc/ext/coverage.rst
@@ -12,7 +12,7 @@ This extension features one additional builder, the :class:`CoverageBuilder`.
    To use this builder, activate the coverage extension in your configuration
    file and give ``-b coverage`` on the command line.
 
-XXX to be expanded.
+.. todo:: Write this section.
 
 Several new configuration values can be used to specify what the builder
 should check:
diff --git a/doc/ext/refcounting.rst b/doc/ext/refcounting.rst
index 225a898b..e2f33871 100644
--- a/doc/ext/refcounting.rst
+++ b/doc/ext/refcounting.rst
@@ -4,4 +4,4 @@
 .. module:: sphinx.ext.refcounting
    :synopsis: Keep track of reference counting behavior.
 
-XXX to be written.
+.. todo:: Write this section.
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``.
diff --git a/doc/extensions.rst b/doc/extensions.rst
index 3f63c64f..62203d7f 100644
--- a/doc/extensions.rst
+++ b/doc/extensions.rst
@@ -39,3 +39,4 @@ These extensions are built in and can be activated by respective entries in the
    ext/refcounting
    ext/ifconfig
    ext/coverage
+   ext/todo