sphinx.ext.todo

module documentation
(source)

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.

Class Todo A todo entry, displayed (if configured) in the form of an admonition.
Class todo_node Undocumented
Class TodoDomain Undocumented
Class todolist Undocumented
Class TodoList A list of all todo entries.
Class TodoListProcessor No class docstring; 0/5 instance variable, 1/4 method documented
Function depart_todo_node Undocumented
Function latex_depart_todo_node Undocumented
Function latex_visit_todo_node Undocumented
Function setup Undocumented
Function visit_todo_node Undocumented
Variable logger Undocumented
def depart_todo_node(self, node): (source)

Undocumented

Parameters
self:HTML5TranslatorUndocumented
node:todo_nodeUndocumented
def latex_depart_todo_node(self, node): (source)

Undocumented

Parameters
self:LaTeXTranslatorUndocumented
node:todo_nodeUndocumented
def latex_visit_todo_node(self, node): (source)

Undocumented

Parameters
self:LaTeXTranslatorUndocumented
node:todo_nodeUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
def visit_todo_node(self, node): (source)

Undocumented

Parameters
self:HTML5TranslatorUndocumented
node:todo_nodeUndocumented
logger = (source)

Undocumented