在Sphinx（Python文档生成器）配置文件中添加扩展

Question

我想使用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上

Answer 1

配置位于Sphinx项目的source文件夹中。它名为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',
    ...
]