Python Sphinx исключает шаблоны

Question

Я генерирую документацию с помощью 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/*.*']

Но даже если рабочий процесс / определения все еще генерируются автоматически.

Может ли кто-нибудь показать мне правильный шаблон исключения, как игнорировать папку "определения"?

Answer 1

exclude_patternsможет использоваться для исключения исходных файлов (файлов reStructuredText) из обработки с помощьюsphinx-build.

exclude_patternsне действует при использовании sphinx-apidoc для генерации файлов reStructuredText из модулей Python (но вы можете сказатьsphinx-apidoc, что определенные имена путей должны быть исключены из генерации).

Answer 2

Документы для exclude_patterns указывают, что 'workflow/definitions' следует игнорировать этот каталог, предполагая, что все исходные файлы заканчиваются .rst,

Вы можете настроить исходный файл в виде списка:

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

Answer 3

Видеть 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.