sphinx.ext.todo

module documentation

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.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable logger Undocumented
Class ​Todo A todo entry, displayed (if configured) in the form of an admonition.
Class todo​_node Undocumented
Class ​Todo​Domain Undocumented
Class todolist Undocumented
Class ​Todo​List A list of all todo entries.
Class ​Todo​List​Processor 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
logger =

Undocumented

def depart_todo_node(self, node):

Undocumented

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

Undocumented

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

Undocumented

Parameters
node:todo_nodeUndocumented
def setup(app):

Undocumented

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

Undocumented

Parameters
node:todo_nodeUndocumented