如何在多个github存储库之间共享Sphinx文档主题？

Question

我从事一个开源项目，该项目由 python API 以及许多作为单独的 python 包安装的 extension 模块组成。所有这些扩展都位于它们自己的 github 存储库中。

我目前正在尝试使用不同的 sphinx 主题 (https://sphinx-themes.org/) 以及我自己添加的一些自定义 CSS 来改进文档的外观。我现在已经更新了核心存储库以使用新主题。这是核心包的docs。

问题是，在我们当前的设置下，我必须发出大约 15 个单独的（但几乎相同的）拉取请求来更新所有不同存储库中的主题。更重要的是，我将来所做的任何更改都必须对每个单独的存储库进行。这显然太费力了，无论如何都不是最佳的工作方式。

我想到的一个解决方案是将文档主题放在自己的存储库中，并让不同的项目以某种方式引入共享主题。尽管我现在确定如何最好地执行此操作。任何建议将不胜感激。

Answer 1

您可以创建主题的 Python 包，确保将其父主题作为依赖项包含在您的需求中。 sphinx-book-theme 就是这样做的。

Answer 2

我们在开发交易策略文档时遇到了同样的问题。

最终，我们放弃了为此寻找一个非常好的解决方案，

并决定将所有文档保存到单个 Git 存储库中。任何包都是此存储库中的 git 子模块依赖项。

然后我们有

一个手动脚本来更新依赖项并进行新的提交和文档构建，也与 CI 操作中的 Github 挂钩相同。