sphinx.ext.todo.TodoListProcessor

class documentation

class TodoListProcessor:

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):

Undocumented

Parameters
app:`Sphinx`	Undocumented
doctree:`nodes.document`	Undocumented
docname:`str`	Undocumented

def create_todo_reference(self, todo, docname):

Undocumented

Parameters
todo:`todo_node`	Undocumented
docname:`str`	Undocumented
Returns
`nodes.paragraph`	Undocumented

def process(self, doctree, docname):

Undocumented

Parameters
doctree:`nodes.document`	Undocumented
docname:`str`	Undocumented

def resolve_reference(self, todo, docname):

Resolve references in the todo content.

Parameters
todo:`todo_node`	Undocumented
docname:`str`	Undocumented

builder =

Undocumented

config =

Undocumented

document =

Undocumented

domain =

Undocumented

env =

Undocumented