Commits

hideki nara committed ae9c10f

spx.py : code cleaned

Comments (0)

Files changed (1)

 # -*- coding: utf-8 -*-
 #"""
-#    sphinx.ext.todo
+#    yummy.spx
 #    ~~~~~~~~~~~~~~~
 #
-#    Allow todos to be inserted into your documentation.  Inclusion of todos can
-#    be switched of by a configuration variable.  The todolist directive collects
-#    all todos of your project and lists them along with a backlink to the
-#    original location.
-#
-#    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
-#    :license: BSD, see LICENSE for details.
+#    A Sphinx extension to render Delicious links  in ".. yummy-list::" directive.
 #"""
 #
 from docutils import nodes
 from sphinx.util.nodes import set_source_info
 from sphinx.util.compat import Directive, make_admonition
 
-#class todo_node(nodes.Admonition, nodes.Element): pass
-#class todolist(nodes.General, nodes.Element): pass
-
-#:Node
+#:Node class
 class yummylist(nodes.General, nodes.Element): pass
 
-#class Todo(Directive):
-#    """
-#    A todo entry, displayed (if configured) in the form of an admonition.
-#    """
-#
-#    has_content = True
-#    required_arguments = 0
-#    optional_arguments = 0
-#    final_argument_whitespace = False
-#    option_spec = {}
-#
-#    def run(self):
-#        env = self.state.document.settings.env
-#        targetid = 'index-%s' % env.new_serialno('index')
-#        targetnode = nodes.target('', '', ids=[targetid])
-#
-#        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)
-#        set_source_info(self, ad[0])
-#        return [targetnode] + ad
-#
-#
-#def process_todos(app, doctree):
-#    # collect all todos in the environment
-#    # 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,
-#            'source': node.source or env.doc2path(env.docname),
-#            'lineno': node.line,
-#            'todo': node.deepcopy(),
-#            'target': targetnode,
-#        })
-
-
-#class TodoList(Directive):
-#    """
-#    A list of all todo entries.
-#    """
-#
-#    has_content = False
-#    required_arguments = 0
-#    optional_arguments = 0
-#    final_argument_whitespace = False
-#    option_spec = {}
-#
-#    def run(self):
-#        # Simply insert an empty todolist node which will be replaced later
-#        # when process_todo_nodes is called
-#        return [todolist('')]
-
+#:Directive class
 class YummyList(Directive):
     """
     A list of URL bookmarks
     """
-
-    has_content = False
-    required_arguments = 0
-    optional_arguments = 0
-    final_argument_whitespace = False
-    option_spec = {}
-
     def run(self):
-        # Simply insert an empty todolist node which will be replaced later
-        # when process_todo_nodes is called
         return [yummylist('')]
 
-#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 = []
-#
-#    for node in doctree.traverse(todolist):
-#        if not app.config['todo_include_todos']:
-#            node.replace_self([])
-#            continue
-#
-#        content = []
-#
-#        for todo_info in env.todo_all_todos:
-#            para = nodes.paragraph(classes=['todo-source'])
-#            description = _('(The <<original entry>> is located in '
-#                            ' %s, line %d.)') % \
-#                          (todo_info['source'], todo_info['lineno'])
-#            desc1 = description[:description.find('<<')]
-#            desc2 = description[description.find('>>')+2:]
-#            para += nodes.Text(desc1, desc1)
-#
-#            # Create a reference
-#            newnode = nodes.reference('', '', internal=True)
-#            innernode = nodes.emphasis(_('original entry'), _('original entry'))
-#            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 += nodes.Text(desc2, desc2)
-#
-#            # (Recursively) resolve references in the todo content
-#            todo_entry = todo_info['todo']
-#            env.resolve_references(todo_entry, todo_info['docname'],
-#                                   app.builder)
-#
-#            # Insert into the todolist
-#            content.append(todo_entry)
-#            content.append(para)
-#
-#        node.replace_self(content)
 
+#: Sphinx Evennt Handlers
 def on_doctree_resolved(app, doctree, fromdocname):
 
     #: configuration check
         node.replace_self(content)
 #        node.parent.replace( nodes.literal_block('hoge','hoge',lineno=3))
 
-#def purge_todos(app, env, docname):
-#    if not hasattr(env, 'todo_all_todos'):
-#        return
-#    env.todo_all_todos = [todo for todo in env.todo_all_todos
-#                          if todo['docname'] != docname]
-#
-
-#def visit_todo_node(self, node):
-#    self.visit_admonition(node)
-#
-#def depart_todo_node(self, node):
-#    self.depart_admonition(node)
 #
 def setup(app):
 #    app.add_config_value('todo_include_todos', False, False)
     #: Node
     app.add_node(yummylist)
 
-#    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),
-#                 man=(visit_todo_node, depart_todo_node),
-#                 texinfo=(visit_todo_node, depart_todo_node))
-
-#    app.add_directive('todo', Todo)
-#    app.add_directive('todolist', TodoList)
-#
     #: Directives
     app.add_directive('yummy_list', YummyList)
 
     #: Event Handler
     app.connect('doctree-resolved', on_doctree_resolved )
-#    app.connect('doctree-read', process_todos)
-#    app.connect('doctree-resolved', process_todo_nodes)
-#    app.connect('env-purge-doc', purge_todos)