sphinx.ext.todo.TodoListProcessor

class documentation

class TodoListProcessor: (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method create_todo_reference Undocumented
Method process Undocumented
Method resolve_reference Resolve references in the todo content.
Instance Variable builder Undocumented
Instance Variable config Undocumented
Instance Variable document Undocumented
Instance Variable domain Undocumented
Instance Variable env Undocumented
def __init__(self, app, doctree, docname): (source)

Undocumented

Parameters
app:SphinxUndocumented
doctree:nodes.documentUndocumented
docname:strUndocumented
def create_todo_reference(self, todo, docname): (source)

Undocumented

Parameters
todo:todo_nodeUndocumented
docname:strUndocumented
Returns
nodes.paragraphUndocumented
def process(self, doctree, docname): (source)

Undocumented

Parameters
doctree:nodes.documentUndocumented
docname:strUndocumented
def resolve_reference(self, todo, docname): (source)

Resolve references in the todo content.

Parameters
todo:todo_nodeUndocumented
docname:strUndocumented
builder = (source)

Undocumented

config = (source)

Undocumented

document = (source)

Undocumented

domain = (source)

Undocumented

env = (source)

Undocumented