- Home
- Get it
- Docs
- Extend/Develop

# `sphinx.ext.todo` – Support for todo items

Module author: Daniel Bültmann

New in version 0.5.

There are two additional directives when using this extension:

`.. todo::`

  Use this directive like, for example, `note`.

  It will only show up in the output if `todo_include_todos` is `True`.

  New in version 1.3.2: This directive supports an `class` option that determines the class attribute for HTML output. If not given, the class defaults to `admonition-todo`.

`.. todolist::`

  This directive is replaced by a list of all todo directives in the whole documentation, if `todo_include_todos` is `True`.

There is also an additional config value:

`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`.

  New in version 1.5.

`todo_link_only`

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

  New in version 1.4.

autodoc provides the following an additional event:

`todo-defined`(app, node)

  New in version 1.5.

  Emitted when a todo is defined. node is the defined `sphinx.ext.todo.todo_node` node.