Python Sphinx 排除模式

Question

我正在使用 Sphinx 为结构如下的项目生成文档：

+ project
|
+- docs
|
+- tests
|
+- workflow -+- definitions -+- <some folders>
             | 
             +- <rest of the project>

我想从文档中排除测试和 workflow/definition。

我尝试在 docs/conf.py

中排除模式

exclude_patterns = ['**/workflow/definitions', 'workflow/definitions', '*workflow/definitions', 'workflow/definitions*', 'workflow/definitions/*', 'workflow/definitions/*.*']

但即使 workflow/definition 仍然会自动生成。

谁能告诉我正确的排除模式如何忽略 'definitions' 文件夹？

Answer 1

exclude_patterns 的文档表明 'workflow/definitions' 应该忽略该目录，假设源文件都以 .rst.

结尾

你可以configure the source file suffices as a list:

source_suffix = ['.rst', '.txt']

Answer 2

exclude_patterns 可用于从 sphinx-build.

处理中排除源文件（reStructuredText 文件）

exclude_patterns 在使用 sphinx-apidoc 从 Python 模块生成 reStructuredText 文件时没有效果（但你可以告诉 sphinx-apidoc某些路径名应从生成中排除）。

Answer 3

参见 sphinx-apidoc --help

中的 EXCLUDE_PATTERN

usage: sphinx-apidoc [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN, ...]

The <EXCLUDE_PATTERN>s can be file and/or directory patterns that will be excluded from generation.

Python Sphinx 排除模式

Python Sphinx exclude patterns

python

python-sphinx

exclusionpath