如何使用Sphinx管理多个版本的文档?

发布于 2024-12-11 03:04:02 字数 1431 浏览 2 评论 0原文

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

隔岸观火 2024-12-18 03:04:02

在我看来,文档应该与代码放在同一个存储库中。否则,您将需要手动管理文档源,例如,当您将功能从版本 B 反向移植到 A 时。使用单个存储库,您只需签出该版本并重新构建文档。

您应该查看 SQLAlchemy 项目,他们在同一站点上提供了多个版本的文档。该文档位于同一存储库中,并且它们复制输出< /a> 将每个版本放入其静态主页文件夹中。

In my opinion, the documentation should stay with the code in the same repository. Otherwise you would need to manage the documentation source manually, for example when you backport a feature from version B to A. With a single repository, you just check out that version and re-build the documentation.

You should look at SQLAlchemy project, they have multiple versions of their documentation available on the same site. The documentation is in the same repository and they copy the output of each version into their static homepage folders.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文