更多Sphinx定制化

除了使用Sphinx核心功能之外,还有两种主要方法可以定制您的文档:扩展和主题。

启用内建扩展

除了这些配置值之外,您还可以通过使用 扩展 来进一步定制Sphinx。Sphinx附带了几种 内建扩展,并且还有许多 由社区维护的第三方扩展

例如,要启用 sphinx.ext.duration 扩展,请在您的 conf.py 中找到 extensions 列表,并按如下方式添加一个元素:

docs/source/conf.py
# 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.duration',
]

之后,每次生成文档时,您将在控制台输出的末尾看到一个简短的持续时间报告,如下所示:

(.venv) $ make html
...
The HTML pages are in build/html.

====================== slowest reading durations =======================
0.042 temp/source/index

使用第三方HTML主题

另一方面,主题是一种定制文档外观的方式。Sphinx有几种 内建主题

例如,要在您的HTML文档中使用第三方主题 Furo,首先,您需要在您的Python虚拟环境中使用 pip 安装它,如下所示:

(.venv) $ pip install furo

然后,在您的 conf.py 中找到 html_theme 变量,并按如下方式替换其值:

docs/source/conf.py
# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'furo'

通过此更改,您会注意到您的HTML文档现在具有新的外观:

使用Furo主题的Lumache HTML文档

使用Furo主题的Lumache HTML文档

现在是时候 扩展叙述性文档并将其拆分为多个文档 了。