Python Sphinx排除模式
我正在使用Sphinx为以下结构的项目生成文档:Python Sphinx排除模式,python,python-sphinx,exclusionpath,Python,Python Sphinx,Exclusionpath,我正在使用Sphinx为以下结构的项目生成文档: + project | +- docs | +- tests | +- workflow -+- definitions -+- <some folders> | +- <rest of the project> 但即使工作流/定义仍然自动生成 有人能告诉我如何忽略“定义”文件夹的正确排除模式吗?的文档表明“工作流/定义”应该忽略该目录,假设源文件都以.rst结尾 你
+ project
|
+- docs
|
+- tests
|
+- workflow -+- definitions -+- <some folders>
|
+- <rest of the project>
但即使工作流/定义仍然自动生成
有人能告诉我如何忽略“定义”文件夹的正确排除模式吗?的文档表明“工作流/定义”
应该忽略该目录,假设源文件都以.rst
结尾
你可以:
可用于从sphinx build处理中排除源文件(重构的文本文件)
exclude_patterns
在使用从Python模块生成重构文本文件时无效(但您可以告诉sphinx apidoc某些路径名应该从生成中排除)。exclude_patterns
只能用于排除RST文件(在运行sphinx build时)。工作流/定义目录是否包含Python文件或RST文件?但是您可以告诉sphinx apidoc某些路径名应该从生成中排除
如何做到这一点?我在或中都找不到任何内容。请参阅处的EXCLUDE\u PATTERN
对于遇到与我类似问题的任何其他人,EXCLUDE\u PATTERN
还需要包括模块路径。e、 gsphinx apidoc-f-o源代码*setup*
仍然从setup.py生成setup.rst,但是sphinx apidoc-f-o source/*安装*
按预期工作。
exclude_patterns = ['**/workflow/definitions', 'workflow/definitions', '*workflow/definitions', 'workflow/definitions*', 'workflow/definitions/*', 'workflow/definitions/*.*']
source_suffix = ['.rst', '.txt']