sphinx.ext.todo – Unterstützung für Todo-Elemente

Modulautor: Daniel Bültmann

Hinzugefügt in Version 0.5.

Bei Verwendung dieser Erweiterung gibt es zwei zusätzliche Direktiven

.. todo::

Verwenden Sie diese Direktive wie zum Beispiel note.

Sie wird nur in der Ausgabe angezeigt, wenn todo_include_todos True ist.

Hinzugefügt in Version 1.3.2: Diese Direktive unterstützt eine class-Option, die das Klassenattribut für die HTML-Ausgabe bestimmt. Wenn diese nicht angegeben ist, ist die Klasse standardmäßig admonition-todo.

.. todolist::

Diese Direktive wird durch eine Liste aller Todo-Direktiven in der gesamten Dokumentation ersetzt, wenn todo_include_todos True ist.

Diese können wie unten gezeigt konfiguriert werden.

Konfiguration

todo_include_todos
Typ:
bool
Standard:
False

Wenn dies True ist, erzeugen todo und todolist eine Ausgabe, andernfalls erzeugen sie nichts.

todo_emit_warnings
Typ:
bool
Standard:
False

Wenn dies True ist, gibt todo für jeden TODO-Eintrag eine Warnung aus.

Hinzugefügt in Version 1.5.

Typ:
bool
Standard:
False

Wenn dies True ist, erzeugt todolist eine Ausgabe ohne Dateipfad und Zeile.

Hinzugefügt in Version 1.4.

autodoc stellt das folgende zusätzliche Ereignis bereit

todo-defined(app, node)

Hinzugefügt in Version 1.5.

Wird ausgelöst, wenn ein TODO definiert wird. node ist der definierte sphinx.ext.todo.todo_node Knoten.