Merge pull request #4217 from Smattr/4a164170-33e9-4df3-aad2-a13af37b6b43

Fix #4214: Two todolist directives break sphinx-1.6.5

CHANGES

@@ -36,6 +36,7 @@ Bugs fixed
 * #4281: Race conditions when creating output directory
 * #4315: For PDF 'howto' documents, ``latex_toplevel_sectioning='part'`` generates
   ``\chapter`` commands 
+* #4214: Two todolist directives break sphinx-1.6.5
 
 Testing
 --------

sphinx/ext/todo.py

@@ -178,7 +178,8 @@ def process_todo_nodes(app, doctree, fromdocname):
             todo_entry = todo_info['todo']
             # Remove targetref from the (copied) node to avoid emitting a
             # duplicate label of the original entry when we walk this node.
-            del todo_entry['targetref']
+            if 'targetref' in todo_entry:
+                del todo_entry['targetref']
 
             # (Recursively) resolve references in the todo content
             env.resolve_references(todo_entry, todo_info['docname'],

tests/roots/test-ext-todo/index.rst

@@ -7,3 +7,5 @@ test for sphinx.ext.todo
    bar
 
 .. todolist::
+
+.. todolist::

tests/test_ext_todo.py

@@ -86,7 +86,7 @@ def test_todo_not_included(app, status, warning):
     assert set(todo[1].astext() for todo in todos) == set(['todo in foo', 'todo in bar'])
 
 @pytest.mark.sphinx('latex', testroot='ext-todo', freshenv=True,
-                    confoverrides={'todo_include_todos': True, 'todo_emit_warnings': True})
+                    confoverrides={'todo_include_todos': True})
 def test_todo_valid_link(app, status, warning):
     """
     Test that the inserted "original entry" links for todo items have a target
@@ -99,11 +99,13 @@ def test_todo_valid_link(app, status, warning):
 
     content = (app.outdir / 'TodoTests.tex').text()
 
-    # Look for the link to foo. We could equally well look for the link to bar.
+    # Look for the link to foo. Note that there are two of them because the
+    # source document uses todolist twice. We could equally well look for links
+    # to bar.
     link = r'\{\\hyperref\[\\detokenize\{(.*?foo.*?)}]\{\\sphinxcrossref{' \
         r'\\sphinxstyleemphasis{original entry}}}}'
     m = re.findall(link, content)
-    assert len(m) == 1
+    assert len(m) == 2
     target = m[0]
 
     # Look for the targets of this link.