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

时间:2015-03-04 08:02:48

标签: python-sphinx

与python或django的文档一样,我如何使用sphinx拥有多个版本的doc?

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

感谢您的帮助

2 个答案:

答案 0 :(得分:14)

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

如果您想在GitHub页面或其他网络服务器上托管您自己的文档,我制作了一个Sphinx扩展程序来执行您正在寻找的内容: https://robpol86.github.io/sphinxcontrib-versioning/

答案 1 :(得分:2)

sphinx-multiversion扩展名。

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

关于项目健康性的注意事项:截至2020年12月,SMV似乎是一个人的项目,并且存在许多未解决的未解决问题和请求请求(尽管请参见{{3} }。