sphinx.ext.todo --処理待ち事項のサポート

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

バージョン 0.5 で追加.

この拡張を使用する場合には、2つの追加命令があります。

.. todo::

この指示を使用して、例えば、 note それがそうです。

以下の場合にのみ出力に表示される todo_include_todos はい。 True それがそうです。

バージョン 1.3.2 で追加: この指示は支持されています class HTML出力のクラス属性を決定するためのオプション。指定されていない場合は，クラスはデフォルトであると考える. admonition-todo それがそうです。

.. todolist::

以下の場合，文書全体中のすべてのTODO命令リストがこの命令を置き換える. todo_include_todos はい。 True それがそうです。

これらの構成は以下のように構成することができる.

配置

todo_include_todos

If this is True, todo and todolist produce output, else they produce nothing. The default is False.

todo_emit_warnings

If this is True, todo emits a warning for each TODO entries. The default is False.

バージョン 1.5 で追加.

todo_link_only

If this is True, todolist produce output without file path and line, The default is False.

バージョン 1.4 で追加.

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

todo-defined(app, node)

バージョン 1.5 で追加.

処理待ち事項を定義する際に発行する. node 定義されています sphinx.ext.todo.todo_node ノードです。