`sphinx.ext.todo` – 待辦事項支援¶

模組作者：Daniel Bültmann

版本 0.5 新增。

當使用此擴充功能時，有兩個額外的指令

.. todo::¶

使用此指令就像，例如，note 一樣。

只有當 todo_include_todos 為 True 時，它才會顯示在輸出中。

版本 1.3.2 新增：此指令支援 class 選項，用於決定 HTML 輸出的 class 屬性。如果未指定，則 class 預設為 admonition-todo。

這些可以如下所示進行設定。

設定¶

todo_include_todos¶

如果此項為 True，todo 和 todolist 會產生輸出，否則它們不會產生任何輸出。

todo_emit_warnings¶

如果此項為 True，todo 會為每個 TODO 條目發出警告。

版本 1.5 新增。

todo_link_only¶

如果此項為 True，todolist 會產生不包含檔案路徑和行的輸出。

版本 1.4 新增。

autodoc 提供以下額外事件

todo-defined(app, node)¶: 版本 1.5 新增。

當定義 todo 時發出。node 是已定義的 sphinx.ext.todo.todo_node 節點。