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

Module author: Daniel Bültmann

New in version 0.5.

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

.. todo::

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

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

.. todolist::

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

この拡張機能によって以下の設定値が追加されます。

todo_include_todos

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