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
isVerdadeiro
.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
forTrue
.
Estes podem ser configurados como visto abaixo.
Configuração¶
- todo_include_todos¶
Se for
True
,todo
etodolist
produz saída, de outra maneira não produz nada. O padrão éFalse
.
- todo_emit_warnings¶
Se for
True
,todo
emite um alerta para cada entrada TODO. O padrão éFalse
.Adicionado na versão 1.5.
- todo_link_only¶
Se for
True
,todolist
produz saída sem caminho do arquivo e linha. O padrão éFalse
.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
.