2015-07-22 24 views
2

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

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

所以我的问题是:

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

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

回答

0

一定要按照tutorial

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

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

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

+0

我知道索引文件和toctree等我在每个手册中使用它。我并不是在讨论将多个.rst文件链接成一个手册,我正在讨论多个手册,每个手册都有自己的conf.py和目录结构,每个手册都使用sphinx-quickstart在自己的目录中启动。它们是发生在同一个存储库中的独立手册。 –

+0

对不起,我完全不理解它。嗯,唯一一次我做了类似于你的设置的远程工作是在一个主conf.py的根目录下,用于配置所有的子目录中的手册......我很想了解将出现在这个线程。 – bufh

相关问题