Включение функции `todo` в документах sphinx

Question

Я пытаюсь использовать функцию todo, я нашел ссылку на sphinx-docs и следующий синтаксис

.. todo::

но это говорит о том, что мне нужно установить todo_include_todos на True, так как по умолчанию это False, какой файл мне нужно обновить, чтобы войти во включенный?

Я нашел еще одно сообщение SO В поле todo Sphinx не отображается , но не думаю, что в нем упоминается файл, в котором мне нужно установить конфигурацию.

Answer 1

sphinx.ext.todo - расширение Sphinx, которое можно включить, добавив его в список расширений в вашем conf.py:

extensions = [
    'extname',
    'sphinx.ext.todo',
]

После включения необходимо настроить его, установив значение todo_include_todos в True, также в вашем conf.py:

# Display todos by setting to True
todo_include_todos = True

Поддержка тем для задач варьируется.

См. Также http://www.sphinx -doc.org / ru / stable / config.html # confval-extensions