结合几个项目的sphinx文档

Question

在我们的团队中,我们有几个项目,每个项目都单独记录了sphinx.我们希望有一个中央文档页面,其中包含我们所有的项目.

当然,我们可以构建一个包含不同文档链接的html页面.

有没有办法将文件与Sphinx本身结合起来？也许有一个单独的文档项目,它以某种方式包含其他项目的文档？

Answer 1

您可以尝试intersphinx在现有文档之间创建链接。这就像维基百科链接到维基媒体世界中的其他维基一样。

另一种方法是将所有文档目录检出到新存储库中。您可能需要创建新的toctrees，因为它要么不适合整体结构，要么嵌套太深。因此，您可以通过将索引文件名更改为例如master.rst.

单独的文档是使用原始文档构建的index.rst，但如果在主文档中使用它，则只有master.rst文件才会被视为toctrees。