0

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

我的存储库使用 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文件，但没有定义文档根文件夹的条目。

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

4

2 回答 2

0

在里面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"]

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

于 2016-05-18T16:02:55.343 回答
0

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

示例值：documentation/conf.py

于 2016-05-24T14:37:57.220 回答