更多的 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 文档

现在是时候 扩大叙事文档,并将其分成几个文件