如何解决具有 2 个长期版本分支的 ReadTheDocs 站点
我的项目有 2 个积极维护的版本(2.x 和 3.x)。 3.x 较新,但我仍在发布 2.x 文档的更新。
如何在 ReadTheDocs 上拥有 2 个文档分支?我想像这样:
https://foo.readthedocs.io/en/2.x
https://foo.readthedocs.io/en/3.x
目前,如果有人访问 https://foo.readthedocs.io/en/latest
,他们会获得 2.x 文档,但 1 年后我想将其翻转以指向 3.x 文档。
阅读 this 页面,似乎我想要 2 个“发布分支”,但我找不到有关此的更多信息。
解决方法
查看 Pyramid's repository,了解我们如何管理分支以在 RTD 上发布我们的文档。我们积极维护三个分支,master
、1.10-branch
和 1.9-branch
,其中 master
是开发分支,1.10-branch
是最新的稳定发布分支。>
在 Admin > Advanced Settings 下的 RTD 中,我们目前将“最新”配置为默认版本,将 1.10-branch
配置为默认分支。我们也不删除旧的分支。通过这种配置,我们发布了 14 个金字塔 RTD“版本”,从 1.0-branch
到 2.0-branch
,加上 master
和 latest
。
- https://docs.pylonsproject.org/projects/pyramid/en/master/
- https://docs.pylonsproject.org/projects/pyramid/en/latest/
- https://docs.pylonsproject.org/projects/pyramid/en/2.0-branch/
- https://docs.pylonsproject.org/projects/pyramid/en/1.10-branch/
- ...等等。
我们还构建拉取请求作为文档构建成功的额外检查,因为 RTD 有时会使用新版本的 Sphinx 更新其构建环境。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。