From 14f378a580db5508b81ed184490f52de535182e1 Mon Sep 17 00:00:00 2001
From: Sean McGinnis <sean_mcginnis@dell.com>
Date: Sat, 23 Jul 2016 18:15:42 -0500
Subject: [PATCH] Docs: remove todo list generation

We had an extension for pulling out todo information from our docs. This
doesn't appear to have ever really been used though. Only a couple todo items
were published to the Cinder documentation, and the two published appear to
be extremely old.

Since this isn't really used and could just cause confusion, removing this
from the index page and removing the sphinx extension used to generate it.

Change-Id: I8993633538a5ee1687c4721bce3c520e8fb4ccfd
---
 doc/ext/cinder_todo.py | 103 -----------------------------------------
 doc/source/conf.py     |   1 -
 doc/source/index.rst   |   5 --
 3 files changed, 109 deletions(-)
 delete mode 100644 doc/ext/cinder_todo.py

diff --git a/doc/ext/cinder_todo.py b/doc/ext/cinder_todo.py
deleted file mode 100644
index bdd64532a3e..00000000000
--- a/doc/ext/cinder_todo.py
+++ /dev/null
@@ -1,103 +0,0 @@
-# This is a hack of the builtin todo extension, to make the todo_list
-# more user friendly
-
-from sphinx.ext.todo import *
-import re
-
-
-def _(s):
-    return s
-
-
-def process_todo_nodes(app, doctree, fromdocname):
-    if not app.config['todo_include_todos']:
-        for node in doctree.traverse(todo_node):
-            node.parent.remove(node)
-
-    # Replace all todolist nodes with a list of the collected todos.
-    # Augment each todo with a backlink to the original location.
-    env = app.builder.env
-
-    if not hasattr(env, 'todo_all_todos'):
-        env.todo_all_todos = []
-
-    # remove the item that was added in the constructor, since I'm tired of
-    # reading through docutils for the proper way to construct an empty list
-    lists = []
-    for i in range(5):
-        lists.append(nodes.bullet_list("", nodes.Text('', '')))
-        lists[i].remove(lists[i][0])
-        lists[i]['classes'].append('todo_list')
-
-    for node in doctree.traverse(todolist):
-        if not app.config['todo_include_todos']:
-            node.replace_self([])
-            continue
-
-        for todo_info in env.todo_all_todos:
-            para = nodes.paragraph()
-            filename = env.doc2path(todo_info['docname'], base=None)
-
-            # Create a reference
-            newnode = nodes.reference('', '')
-
-            line_info = todo_info['lineno']
-            link = _('%(filename)s, line %(line_info)d') % locals()
-            innernode = nodes.emphasis(link, link)
-            newnode['refdocname'] = todo_info['docname']
-
-            try:
-                newnode['refuri'] = app.builder.get_relative_uri(
-                    fromdocname, todo_info['docname'])
-                newnode['refuri'] += '#' + todo_info['target']['refid']
-            except NoUri:
-                # ignore if no URI can be determined, e.g. for LaTeX output
-                pass
-
-            newnode.append(innernode)
-            para += newnode
-            para['classes'].append('todo_link')
-
-            todo_entry = todo_info['todo']
-
-            env.resolve_references(todo_entry, todo_info['docname'],
-                                   app.builder)
-
-            item = nodes.list_item('', para)
-            todo_entry[1]['classes'].append('details')
-
-            comment = todo_entry[1]
-
-            m = re.match(r"^P(\d)", comment.astext())
-            priority = 5
-            if m:
-                priority = int(m.group(1))
-                if priority < 0:
-                    priority = 1
-                if priority > 5:
-                    priority = 5
-
-            item['classes'].append('todo_p' + str(priority))
-            todo_entry['classes'].append('todo_p' + str(priority))
-
-            item.append(comment)
-
-            lists[priority - 1].insert(0, item)
-
-        node.replace_self(lists)
-
-
-def setup(app):
-    app.add_config_value('todo_include_todos', False, False)
-
-    app.add_node(todolist)
-    app.add_node(todo_node,
-                 html=(visit_todo_node, depart_todo_node),
-                 latex=(visit_todo_node, depart_todo_node),
-                 text=(visit_todo_node, depart_todo_node))
-
-    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)
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f70900170d8..8d1656cc870 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -29,7 +29,6 @@ sys.path.insert(0, os.path.abspath('./'))
 # or your custom ones.
 
 extensions = ['sphinx.ext.autodoc',
-              'ext.cinder_todo',
               'sphinx.ext.coverage',
               'sphinx.ext.ifconfig',
               'sphinx.ext.graphviz',
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 0fee7585e1d..b8cbee67005 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -60,11 +60,6 @@ Sample Configuration File
 
     sample_config
 
-Outstanding Documentation Tasks
-===============================
-
-.. todolist::
-
 Indices and tables
 ==================