3.15. sphinx.ext.todo¶
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-2016 by the Sphinx team, see AUTHORS. |
|---|---|
| license: | BSD, see LICENSE for details. |
3.15.1. Functions¶
depart_todo_node(self, node) |
|
make_admonition(node_class, name, arguments, ...) |
|
merge_info(app, env, docnames, other) |
|
process_todo_nodes(app, doctree, fromdocname) |
|
process_todos(app, doctree) |
|
purge_todos(app, env, docname) |
|
set_source_info(directive, node) |
|
setup(app) |
|
visit_todo_node(self, node) |
3.15.2. Classes¶
Directive(name, arguments, options, content, ...) |
Base class for reStructuredText directives. |
Todo(name, arguments, options, content, ...) |
A todo entry, displayed (if configured) in the form of an admonition. |
TodoList(name, arguments, options, content, ...) |
A list of all todo entries. |
todo_node([rawsource]) |
|
todolist([rawsource]) |