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

Question

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

我的特殊之处在于该项目包含 2 个 Sphinx 文档（例如程序员手册和用户手册）。ReadTheDocs 似乎正在检测两者（有两个 conf.py）并构建两者。但是，在显示它们时，它只显示其中一个的 html，据我所知，第一个按字母顺序显示。

所以我的问题是：

1. 如果两者都已建成，您如何才能看到另一个？

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

Answer 1

请务必按照教程进行操作。

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

然后必须在目录树或包含或链接等中引用每个文件。

查看 github 上的示例（即：Sphinx-doc 存储库）。