sphinx.ext.todo – Suporta itens todo

Autor do módulo: Daniel Bültmann

Adicionado na versão 0.5.

Existem duas diretivas adicionais quando usamos essa extensão:

.. todo::

Use essa diretivo, como por exemplo, note.

Somente será exibida saída se todo_include_todos is Verdadeiro.

Adicionado na versão 1.3.2: Essa diretiva suporta uma opção class que determina a classe dos atributos para saída HTML. Se não informado, a classe padrão será admonition-todo.

.. todolist::

Essa diretiva é substituída por uma lista de todas as diretivas em toda a documentação, se todo_include_todos for True.

Estes podem ser configurados como visto abaixo.

Configuração

todo_include_todos
Type:
bool
Default:
False

Se for True, todo e todolist produz saída, de outra maneira não produz nada.

todo_emit_warnings
Type:
bool
Default:
False

Se for True, todo emite um aviso para cada entrada TODO.

Adicionado na versão 1.5.

Type:
bool
Default:
False

Se for True, todolist produz saída sem caminho do arquivo e linha.

Adicionado na versão 1.4.

autodoc providência o seguinte evendo adicional:

todo-defined(app, node)

Adicionado na versão 1.5.

Emitir quando um todo é definido. node é definido node sphinx.ext.todo.todo_node.