时间戳

首页 > 解决方案 > apidoc 不排除 exclude_patterns

python - apidoc 不排除 exclude_patterns

问题描述

我有以下目录结构：

+project_name
|
+---project_name
|   |---subpackage
|       |---__init__.py
|       |---api.py
|       |---mock_run.py
|
+---docs
    |---conf.py

我不想在我的文档中使用 mock_run，所以在conf.py我有：
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store','mock', '**/mock_*', '*/mock_*','mock_run.py']

我运行sphinx-apidoc -o docs/ project_name -f -M（我还清理了make docsmakefile 中的所有内容）。

该文件仍然出现在文档中。我究竟做错了什么？

正如你所看到的，我已经尝试了许多不同的版本来捕获正则表达式，所以我相信这不是问题。

标签： pythonpython-sphinxsphinx-apidocexclusionpath

解决方案

似乎 conf.py 中的 exclude_patterns 不是用于 api-doc 而是用于（也许）make html。解决方案是在命令行中运行 apidoc 的排除模式

sphinx-apidoc -o docs/ project_name "**/mock_*" -f -M

推荐阅读