我正在使用 Sphinx 为具有如下结构的项目生成文档:
+ project
|
+- docs
|
+- tests
|
+- workflow -+- definitions -+- <some folders>
|
+- <rest of the project>
我想从文档中排除测试和工作流/定义。我在 docs/conf.py 中尝试了排除模式
exclude_patterns = ['**/workflow/definitions', 'workflow/definitions', '*workflow/definitions', 'workflow/definitions*', 'workflow/definitions/*', 'workflow/definitions/*.*']
但是即使工作流/定义仍然是自动生成的。有人可以告诉我正确的排除模式如何忽略“定义”文件夹吗?
最佳答案
exclude_patterns
可用于从 处理中排除源文件(reStructuredText 文件)狮身人面像构建 .exclude_patterns
使用 sphinx-apidoc 时无效从 Python 模块生成 reStructuredText 文件(但您可以告诉 sphinx-apidoc 某些路径名应该从生成中排除)。
关于Python Sphinx 排除模式,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/43801615/