安装

如何安装和使用主题

安装 sphinx_rtd_theme 包（或将其添加到您的 requirements.txt 文件中）

$ pip install sphinx_rtd_theme

在您的 Sphinx 项目的 conf.py 文件中，将 sphinx_rtd_theme 添加到已启用扩展的列表中，并将其设置为活动主题

extensions = [
    ...
    'sphinx_rtd_theme',
]

html_theme = "sphinx_rtd_theme"

另请参阅

支持的浏览器

官方支持和测试的浏览器/操作系统组合

支持的依赖项

官方支持的 Python、Sphinx 和其他依赖项版本。

注意

将此主题添加为扩展会激活 sphinxcontrib-jquery 扩展，该扩展是搜索、平滑滚动和弹出菜单所必需的。如果这些功能中的任何一个无法正常工作，请确保您已在 extensions 中声明了主题。

如何升级

将 sphinx-rtd-theme 添加到项目的依赖项中，pip 将安装最新兼容版本的主题。

如果要测试 **预发布版本**，则需要明确指定版本。否则，pip 将忽略预发布版本。例如，添加 sphinx-rtd-theme==1.1.0b3 以测试预发布版本。

提示

建议您固定项目构建所使用的 Sphinx 版本。我们不会在未标记其与 Sphinx 的兼容性之前发布 sphinx-rtd-theme。因此，如果您没有固定 sphinx-rtd-theme 本身，您将始终获得最新兼容版本。

更多信息可在 Read the Docs 的文档中找到，请参阅 如何创建可重复构建。