【问题标题】:Documentation tag versions with Sphinx带有 Sphinx 的文档标签版本
【发布时间】:2019-07-04 08:11:54
【问题描述】:

我在下面使用 Sphinx 为我的项目生成文档。 如何根据标签/分支生成多个版本?

我确实检查了库sphinxcontrib-versioning,但由于它最近没有更新,它似乎坏了。有什么我可以调查的吗?谁能告诉我来源?

【问题讨论】:

    标签: python versioning python-sphinx


    【解决方案1】:

    这是发布多个文档版本的一种方法,以 Pyramid 和 Read the Docs 为例。

    conf.py on the master branch 与其他编号的分支进行比较。版本几乎相同,除了older versions 我们贴上一个固定的 div,上面写着“阅读此页面的最新版本”并链接到最新的稳定版本,对于master branch,我们贴上一个警告徽章“通知文档正在进行中”。

    然后configure RTD to build multiple versions 您的文档。

    【讨论】:

    • 感谢您的回复。我面临一个问题,由于我的教程 python 文件上的导入更改(似乎它在当前版本的项目而不是特定版本上运行),为特定标签/分支创建文档失败。他们是我们可以忽略这些 Sphinx 错误并继续创建文档的一种方式吗?使用 sphinxcontrib-versioning
    • 你必须修复你的导入。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-07-06
    相关资源
    最近更新 更多