开发
主题开发者遵循以下准则进行开发和发布计划。文档作者可以根据所需的浏览器/操作系统组合或依赖项支持来决定哪个主题版本最适合他们的项目。
支持的浏览器
官方浏览器支持由我们页面浏览量分析中最为流行的浏览器/操作系统组合决定。正式支持的组合在开发过程中通常会进行测试，并且在发布新版本主题之前始终会进行测试。
支持组合的旧版本以及一些不太常见的组合被视为部分支持。这意味着我们不会持续测试这些组合，但是我们预计用户体验将与支持的组合相当。
浏览器 |
操作系统 |
版本 |
|---|---|---|
Chrome |
Windows、MacOS、Linux、Android |
>=90 |
Firefox |
Linux、Windows |
>=90 |
Edge |
Windows |
>=90 |
Safari |
MacOS、iOS |
>=13 |
版本 1.0 中的新增功能： 添加了支持的浏览器和操作系统组合
主题开发者根本不支持几种浏览器/操作系统组合。不支持的组合不会进行测试或开发，并且我们可能不会接受针对这些组合的主要贡献。
不支持的浏览器/操作系统组合包括
- Internet Explorer（任何操作系统，任何版本）
支持已在 3.0.0 版本中移除。
- Opera（任何操作系统，任何版本）
仅限社区支持。 我们没有收到足够的来自该浏览器的流量来在测试和开发中正式支持它。
支持的依赖项
该主题在您的 Sphinx 项目中正式支持以下依赖项
依赖项 |
版本 |
|---|---|
Python |
3.8 或更高版本 |
Sphinx |
6 或更高版本 |
docutils |
> 0.18, < 0.22 |
自版本 3.0 起已弃用： 已移除 Sphinx < 6 的支持
自版本 2.0 起已弃用： 已移除 Sphinx < 5 的支持
自版本 2.0 起已弃用： 已移除 Python < 3.6 的支持
自版本 2.0 起已弃用： 已移除 docutils < 0.14 的支持
版本 1.0 中的新增功能： 添加了 Sphinx 4.0 的支持
自版本 1.0 起已弃用： 已移除 Sphinx 1.6 的支持
版本 1.0 中的新增功能： 添加了 docutils 0.17 的支持
路线图
我们目前在开发路线图上计划了几个版本。每个版本的向后不兼容更改、弃用和主要功能都已注明。
版本遵循 语义版本控制，因此通常建议作者将对 sphinx_rtd_theme 的依赖项固定到下一个主要版本之前的某个版本
$ pip install "sphinx_rtd_theme<2.0.0"
1.0.0
- 计划发布日期:
2021 年 8 月
此版本将是一个略微向后不兼容的版本，以遵循 0.5.2 版本。它将放弃对 Sphinx 1.6 的支持，这在此时是一个相当旧的版本。
此版本将添加对 Sphinx 4.x 版本系列的正式支持，并解决 Docutils 最新版本（版本 0.17）中的错误。
从本版本开始，将在构建时发出一些弃用警告
1.1.0
- 计划发布日期:
2021 年第三季度
我们的目标是在 1.x 版本系列中至少发布一个错误修复版本以跟进版本 1.0.0。1.1 版本不会添加任何主要功能，而是将标记针对具有旧依赖项（如 Sphinx 1.8、HTML4 或需要 IE11 支持）的项目的最后一个版本。
2.0.0
- 计划发布日期:
2023 年第三季度
此版本将放弃对旧版 Python 和 Sphinx 版本的支持。
请注意，此版本计划进行以下向后不兼容更改
- Python < 3.6、Sphinx < 5 和 Docutils < 0.14 将不会进行测试
对这些版本的正式支持将被放弃，尽管它们可能仍会继续工作。主题开发者将不再测试这些版本。
- 将移除 HTML4 支持
从本版本开始，我们只支持 HTML5 编写器输出，尝试使用 HTML4 编写器的构建将失败。如果您仍在使用 HTML4 编写器，或者在 Sphinx 配置文件中具有
html4_writer = True选项，则需要移除此选项或将您的依赖项固定到sphinx_rtd_theme<=3，直到您可以这样做。过去曾建议使用此选项来解决 HTML5 支持问题，并且现在不再需要使用此主题和 Sphinx 的现代组合。
3.0.0
- 计划发布日期:
2024 年第三季度
此版本将放弃对旧版 Python 和 Sphinx 版本的支持，并将添加对新版本的支持。
- 将移除 Sphinx 5、Python < 3.8 和 docutils < 0.18 的支持
Sphinx 5 是支持 Python 3.6 和 3.7 的最新版本，docutils < 0.18 也是如此。
- 将放弃对 Internet Explorer 11 的支持
IE11 于 2022 年 6 月 14 日结束生命周期，因此我们从 3.0.0 版本开始不再支持它。
4.0.0
- 计划发布日期:
2024 年第二季度
此版本尚未计划。计划在 3.0 之后的某个版本中可能用 Bootstrap 替换 Wyrm。
此版本还暂定计划最终从我们的存储库中移除已构建的 CSS 和 JavaScript 资产。这将移除直接从 GitHub 安装软件包的功能，取而代之的是建议用户从 PyPI 安装开发版本。