支持的 Python 和 Sphinx 版本#

Python 和 Sphinx 是此主题的两个主要依赖项。我们在决定支持哪些版本的这些依赖项方面有特定的实践(特别是 Sphinx,它往往会发布重大更改)。

支持的 Python 版本#

对于 Python 的发布,我们旨在遵循此方法[1]

对于此主题的新主要/次要版本,我们支持在过去 3.5 年(42 个月)内发布的任何次要 Python 版本,如 Python 的 EOL 日程表[2] 中定义的。

我们将“支持”定义为针对每个版本进行测试,以便用户可以确保他们不会触发任何错误。

例如,如果我们明天发布了一个次要版本,我们会查看 Python 的 EOL 日程表,并支持所有属于 3.5 年窗口的版本。

支持的 Sphinx 版本#

对于支持的 Sphinx 版本,我们旨在遵循此方法

我们支持最新的已发布的 Sphinx 版本,该版本比 **6 个月** 大。我们非正式地支持早期发布的 Sphinx 版本,但如果需要,可能会在没有警告的情况下增加依赖项固定中的下限[2]

当发布新的 Sphinx 预发布版本时,我们应该遵循以下步骤

  • 确保我们的测试通过。我们使用任何 **预发布** Sphinx 版本运行我们的测试,以便我们可以快速测试重大错误并进行必要的更改。

  • 查看 Sphinx 变更日志 并确保没有可能导致我们测试无法捕获的错误的更改。

  • 查看已弃用的 API 更改 并确保没有可能导致我们测试无法捕获的错误的更改。

  • 查看 docutils 变更日志,以防支持新的 docutils 版本导致某些内容出现问题。

注意

此主题不会固定它支持的 Sphinx 的上限版本。如果 Sphinx 版本导致用户出现重大错误,而我们没有能力更新我们的代码并发布修复程序,我们可能会暂时固定我们支持的 Sphinx 的上限,直到修复此问题。