`sphinx.ext.todo` – ToDo項目のサポート¶

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

バージョン 0.5 で追加されました。

この拡張機能を使用すると、2つの追加ディレクティブが利用できます。

.. todo::¶

このディレクティブは、例えば、noteのように使用します。

todo_include_todos が True の場合にのみ、出力に表示されます。

バージョン 1.3.2 で追加: このディレクティブは、HTML出力のクラス属性を決定する class オプションをサポートしています。指定しない場合、クラスはデフォルトで admonition-todo になります。

.. todolist::¶: このディレクティブは、todo_include_todos が True の場合、ドキュメント全体にあるすべての todo ディレクティブのリストに置き換えられます。

これらは以下のように設定できます。

設定¶

todo_include_todos¶: これが True の場合、todo と todolist は出力を生成し、そうでない場合は何も生成しません。デフォルトは False です。

todo_emit_warnings¶: これが True の場合、todo は各TODOエントリに対して警告を発します。デフォルトは False です。

バージョン 1.5 で追加されました。

todo_link_only¶: これが True の場合、todolist はファイルパスと行番号なしの出力を生成します。デフォルトは False です。

バージョン 1.4 で追加されました。

autodocは、以下の追加イベントを提供します。

todo-defined(app, node)¶: バージョン 1.5 で追加されました。

todoが定義されたときに発行されます。 node は、定義されたsphinx.ext.todo.todo_nodeノードです。