todo

These are several possibilities to document a todo:

  • Explain what needs to be be done by using simple text.

  • An invisible comment for the maintainers of the documentation.

  • The third party sphinx.ext.todo directive:

    Todo

    It adds an intrusive todo-box for each todo. Use it with care to avoid noise in the documentation.

  • The :todo: role from this extension for a short text like a single word. The todo-keyword is not visible, but you can still search for “todo” in the sources of the documentation.

    Example:

    html

    rst

    dox_util and another extension.

    		 
    :ref:`dox_util` and :todo:`another extension`.