Python Sphinx排除模式

Question

Python Sphinx排除模式

jmt*_*jmt 8 python-2.7 python-sphinx autodoc

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

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

Run Code Online (Sandbox Code Playgroud)

我想从文档中排除测试和工作流/定义.

我尝试在docs/conf.py中排除模式

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

Run Code Online (Sandbox Code Playgroud)

但即使工作流/定义仍然自动生成.

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

Answer 1

mzj*_*zjn 13

exclude_patterns可用于从sphinx-build处理中排除源文件(reStructuredText文件).

exclude_patterns使用sphinx-apidoc从Python模块生成reStructuredText文件时没有任何效果(但是你可以告诉sphinx-apidoc应该从生成中排除某些路径名).

对于遇到与我类似问题的其他人，“EXCLUDE_PATTERN”也需要包含模块路径。例如`sphinx-apidoc -f -o source .. *setup*`仍然从setup.py生成setup.rst，但是`sphinx-apidoc -f -o source .. ../*setup*`按预期工作。 (7认同)
“但是您可以告诉sphinx-apidoc，某些路径名应从世代中排除”您该怎么做？在[apidoc页面]（http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html）和[autodoc config docs]（http：/ /www.sphinx-doc.org/en/stable/usage/extensions/autodoc.html#module-sphinx.ext.autodoc）。 (3认同)
请参阅http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html上的“ EXCLUDE_PATTERN”。 (3认同)

归档时间：	8 年，5 月前
查看次数：	5889 次
最近记录：	8 年，5 月前