sphinx.ext.todo -- Todoアイテムのサポート

モジュールの作者: Daniel Bültmann

Added in version 0.5.

この拡張を使用すると、以下の二つのディレクティブが追加されます:

.. todo::

このディレクティブは note と同じように使用できます。

このディレクティブの内容は todo_include_todos が True の場合だけ表示されます。

Added in version 1.3.2: このディレクティブはHTML中のclass属性を指定するための class オプションをサポートします。指定しない場合、 admonition-todo が適用されます。

.. todolist::

このディレクティブは、全ドキュメントのすべてのtodoディレクティブを含むリストで置換されます。 todo_include_todos が True になったときだけ表示されます。

ディレクティブの動作は設定で変更できます。

設定

todo_include_todos

もしもこの設定値がTrueに設定されると、todoとtodolistのディレクティブが出力を出すようになります。Falseが設定されると何も出力されなくなります。デフォルトはFalseです。

todo_emit_warnings

この設定値が True に設定されると、 todo は各TODOエントリーに警告を出します。デフォルトは False です。

Added in version 1.5.

この設定値が True に設定されると、 todolist はファイルパスと行を含めずに出力を出します。デフォルトは False です。

Added in version 1.4.

autodoc では以下の追加イベントが提供されます:

todo-defined(app, node)

Added in version 1.5.

todoが定義されたら発生します。 node は sphinx.ext.todo.todo_node です。