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

我想使用ReadTheDocs来托管我的Sphinx文档。该项目在github上托管。我可以连接到它很好。如何在ReadTheDocs的一个项目中设置多个Sphinx文档?

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

所以我的问题是:

  1. 如果两个已经建成,你怎么能看到另一个?

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

回答:

一定要按照tutorial。

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

然后,每个文件必须被引用的,无论是在一个toctree或包括,或链路等

看在github例子(即:Sphinx-doc repository)。

以上是 如何在ReadTheDocs的一个项目中设置多个Sphinx文档? 的全部内容, 来源链接: utcz.com/qa/266102.html

回到顶部