18

我正在使用 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/*.*']

但是即使工作流/定义仍然是自动生成的。

有人可以告诉我正确的排除模式如何忽略“定义”文件夹吗？

4

3 回答 3

18

exclude_patterns可用于从sphinx-build处理中排除源文件（reStructuredText 文件） 。

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

于 2017-05-09T11:05:13.513 回答
1

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

您可以将源文件配置为列表：

source_suffix = ['.rst', '.txt']
于 2017-05-05T18:54:59.597 回答
0

请参见 EXCLUDE_PATTERN 中的sphinx-apidoc --help

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.
于 2021-07-21T09:45:20.730 回答