RTD 编译我所有的文档，包括来自 git 个子模块的外国文档

Question

我正在尝试使用 Sphinx and ReadTheDocs (RTD) 在每次 GitHub 推送时编译我的文档。不幸的是，RTD 发现多个 doc/docs 文件夹包含一个 conf.py 文件。

我的 repository 使用 git 子模块嵌入第三方库。其中一些还使用 Sphinx 进行了记录。我假设最大的（持久的文档构建）获胜并覆盖最终 RTD 视图中的所有静态 HTML 页面。

如何排除或告诉 RTD 忽略这些子模块的文件夹：

lib/cocotb
lib/osvvm
lib/vunit
docs/source/_themes/sphinx_rtd_theme

我的文档位于此处：

docs/source/conf.py
docs/source/index.rst

据我所知，RTD 确实支持 *.yml 文件，但没有定义文档根文件夹的条目。

有什么办法可以解决我的问题吗？

Answer 1

在conf.py里面，有一个看起来像这样的列表

 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = []

你可以把你想忽略的文件放在里面，比如

exclude_patterns = ["lib/cocotb", "lib/osvvm", "lib/vunit", "docs/_themes/sphinx_rtd_theme"]

请注意，这里的模式是相对于源目录的，你可以在上面每个文件模式的开头加上/，这样更清楚。

Answer 2

主文档文件夹及其 conf.py 可以在每个项目设置的 高级设置 选项卡中进行配置。

示例值：documentation/conf.py

RTD 编译我所有的文档，包括来自 git 个子模块的外国文档

RTD compiles all my docs including foreign docs from git submodules

git-submodules

python-sphinx

read-the-docs