Добавление расширения в конфигурационный файл Sphinx (генератор документации Python)

#python #macos #python-sphinx

#python #macos #python-sphinx

Вопрос:

Я хочу использовать Sphinx в качестве генератора документации. Когда я пытаюсь запустить команду make html, у меня появляется следующая ошибка :

Extension error:
Could not import extension sphinxcontrib.httpdomain (exception: No module named sphinxcontrib.httpdomain)
make: *** [html] Error 1

Я нашел эту веб-страницу, объясняющую, что я должен вручную добавить расширение в файл конфигурации Sphinx https://pythonhosted.org/sphinxcontrib-httpdomain/#module-sphinxcontrib.httpdomain

Но я не могу найти этот файл конфигурации.

У вас есть какие-либо идеи, где я мог бы его найти? Я на Mac OS X

Ответ №1:

Конфигурация находится в source папке вашего проекта Sphinx. Он назван conf.py и содержит extensions параметр, который должен выглядеть следующим образом:

 # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    ...
]