如何使用sphinx获得多个版本的doc？

Question

像python或django的文档一样,我如何使用sphinx获得多个版本的doc？

我保存在我的git的文档,我希望我的用户能够看到文档不同版本的一样v2.7,v3.4等

感谢您的帮助

Answer 1

您可以使用"阅读文档"为您托管文档.它们通过下拉列表自动处理多个版本:https: //docs.readthedocs.io/en/latest/index.html

如果您想在GitHub页面或其他一些Web服务器上托管您自己的文档,我制作了一个Sphinx扩展程序,可以满足您的需求:https: //robpol86.github.io/sphinxcontrib-versioning/

Answer 2

有sphinx-multiversion扩展。

它类似于 sphinxcontrib-versioning，但 sphinxcontrib-versioning 似乎并没有得到积极维护。最后一个版本是在 2016 年，它不适用于更新版本的 Sphinx（问题 #77）。sphinx-multiversion 是一个新的实现（见作者评论）。

关于项目健康性的说明：截至 2020 年 12 月，SMV 似乎是一个单人项目，并且有许多未解决的问题和拉取请求尚未得到回应（尽管请参阅作者的此评论）。