如何在ReadTheDocs中的一个项目中设置多个Sphinx文档?

时间:2015-07-22 03:38:26

标签: github python-sphinx read-the-docs

我想使用ReadTheDocs来托管我的Sphinx文档。该项目托管在github上。我可以很好地连接它。

我的特殊之处在于该项目包含2个Sphinx文档(例如程序员手册和用户手册)。 ReadTheDocs似乎正在检测两者(有两个conf.py)并构建两者。然而,当涉及到显示它们时,它只显示其中一个的html,据我所知,第一个按字母顺序排列。

所以我的问题是:

  1. 如果两者都已建成,你如何看到另一个?

  2. 有没有办法使用“子项目”来指定每个conf.py的路径,因此每个文档/手册都有清晰的URL?那将是理想的解决方案。

1 个答案:

答案 0 :(得分:-1)

请务必遵循tutorial

通常你需要一个索引(在conf.py中,它被称为master_doc)。

然后必须在toctree或include或链接等中引用每个文件。

查看github上的示例(即:Sphinx-doc repository)。