sphinx.ext.todo
-- Todoアイテムのサポート¶
モジュールの作者: Daniel Bültmann
バージョン 0.5 で追加.
この拡張を使用すると、以下の二つのディレクティブが追加されます:
- .. todo::¶
このディレクティブは
note
と同じように使用できます。このディレクティブの内容は
todo_include_todos
がTrue
の場合だけ表示されます。バージョン 1.3.2 で追加: このディレクティブはHTML中のclass属性を指定するための``class``オプションをサポートします。指定しない場合、``admonition-todo``が適用されます。
- .. todolist::¶
このディレクティブは、全ドキュメントのすべてのtodoディレクティブを含むリストで置換されます。
todo_include_todos
がTrue
になったときだけ表示されます。
ディレクティブの動作は設定で変更できます。
設定¶
- todo_include_todos¶
もしもこの設定値が
True
に設定されると、todo
とtodolist
のディレクティブが出力を出すようになります。False
が設定されると何も出力されなくなります。デフォルトはFalse
です。
autodoc では以下の追加イベントが提供されます:
- todo-defined(app, node)¶
バージョン 1.5 で追加.
todoが定義されたら発生します。 node は
sphinx.ext.todo.todo_node
です。