#286: collect todo nodes after the whole document has been read; this allows placing substitution references in todo items.

CHANGES

@@ -1,6 +1,9 @@
 Release 0.6.4 (in development)
 ==============================
 
+* #286: collect todo nodes after the whole document has been read;
+  this allows placing substitution references in todo items.
+
 * #294: do not ignore an explicit ``today`` config value in a
   LaTeX build.
 

sphinx/ext/todo.py

@@ -42,20 +42,31 @@ class Todo(Directive):
         ad = make_admonition(todo_node, self.name, [_('Todo')], self.options,
                              self.content, self.lineno, self.content_offset,
                              self.block_text, self.state, self.state_machine)
+        ad[0].line = self.lineno
+        return [targetnode] + ad
 
-        # Attach a list of all todos to the environment,
+
-        # the todolist works with the collected todo nodes
+def process_todos(app, doctree):
-        if not hasattr(env, 'todo_all_todos'):
+    # collect all todos in the environment
-            env.todo_all_todos = []
+    # this is not done in the directive itself because it some transformations
+    # must have already been run, e.g. substitutions
+    env = app.builder.env
+    if not hasattr(env, 'todo_all_todos'):
+        env.todo_all_todos = []
+    for node in doctree.traverse(todo_node):
+        try:
+            targetnode = node.parent[node.parent.index(node) - 1]
+            if not isinstance(targetnode, nodes.target):
+                raise IndexError
+        except IndexError:
+            targetnode = None
         env.todo_all_todos.append({
             'docname': env.docname,
-            'lineno': self.lineno,
+            'lineno': node.line,
-            'todo': ad[0].deepcopy(),
+            'todo': node.deepcopy(),
             'target': targetnode,
         })
 
-        return [targetnode] + ad
-
 
 class TodoList(Directive):
     """
@@ -152,6 +163,7 @@ def setup(app):
 
     app.add_directive('todo', Todo)
     app.add_directive('todolist', TodoList)
+    app.connect('doctree-read', process_todos)
     app.connect('doctree-resolved', process_todo_nodes)
     app.connect('env-purge-doc', purge_todos)