【问题标题】:ReadTheDocs site with 2 long-term version branches具有 2 个长期版本分支的 ReadTheDocs 站点
【发布时间】:2021-01-17 04:23:47
【问题描述】:

我的项目有 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 个“发布分支”,但我找不到有关此的更多信息。

【问题讨论】:

    标签: python-sphinx read-the-docs


    【解决方案1】:

    查看Pyramid's repository,了解我们如何管理分支以在 RTD 上发布我们的文档。我们积极维护master、1.10-branch和1.9-branch三个分支,其中master是开发分支,1.10-branch是最新稳定发布的分支。

    在 Admin > Advanced Settings 下的 RTD 中,我们目前将“最新”配置为默认版本,1.10-branch 配置为默认分支。我们也不会删除旧分支。通过这种配置,我们发布了 Pyramid 的 14 个 RTD“版本”,从 1.0-branch 到 2.0-branch,再加上 master 和 latest。

    我们还构建拉取请求作为文档构建成功的额外检查,因为 RTD 有时会使用新版本的 Sphinx 更新其构建环境。

    【讨论】:

      猜你喜欢
      • 2012-08-05
      • 2023-03-09
      • 2020-02-28
      • 2018-07-24
      • 1970-01-01
      • 2011-09-22
      • 2017-03-03
      • 2016-03-01
      • 2012-08-30
      相关资源
      最近更新 更多