如何使用 sphinx 拥有多个版本的文档？答案

【问题标题】：How do I have multiple versions of my doc with sphinx?如何使用 sphinx 拥有多个版本的文档？
【发布时间】：2015-03-04 08:02:48
【问题描述】：

像 python 或 django 的文档一样，我如何使用 sphinx 拥有多个版本的文档？

我将我的文档保存在 git 上，我希望我的用户能够查看不同版本的文档，例如 v2.7、v3.4 等

感谢您的帮助

【问题讨论】：

你想要一个可以选择版本的下拉列表，比如左上角docs.python.org/2吗？
@mzjn 正是我想要的
另见stackoverflow.com/questions/7850093/…

标签： python-sphinx

【解决方案1】：

您可以只使用 Read The Docs 来为您托管文档。他们通过下拉菜单自动处理多个版本： https://docs.readthedocs.io/en/latest/index.html

如果您想在 GitHub Pages 或其他 Web 服务器上托管您自己的文档，我制作了一个 Sphinx 扩展来满足您的需求： https://github.com/sphinx-contrib/sphinxcontrib-versioning

【讨论】：

ReadTheDocs 似乎只为用户提供两个版本：stable 和latest（这是指向最近标记版本的指针）。这并没有真正解决 OP 的要求，即提供任意数量的版本。
我相信 readthedocs 可以让您在他们的 UI 中添加自己的版本

【解决方案2】：

有sphinx-multiversion 扩展名。

它类似于 sphinxcontrib-versioning，但 sphinxcontrib-versioning 似乎没有得到积极维护。最后一个版本是在 2016 年，它不适用于最新版本的 Sphinx (issue #77)。 sphinx-multiversion 是一个新的实现（参见comment by the author）。

关于项目健康状况的说明：截至 2020 年 12 月，SMV 似乎是一个单人项目，并且有许多未解决的问题和拉取请求尚未得到响应（尽管参见 this comment by the author） .

【讨论】：