结合几个项目的sphinx文档

时间:2017-07-17 06:25:59

标签: python-3.x documentation python-sphinx

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

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

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

1 个答案:

答案 0 :(得分:2)

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

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

使用原始index.rst构建单个文档,但如果在主文档中使用,则只有master.rst个文件将被视为toctree