【问题标题】:apidoc not excluding exclude_patterns [duplicate]apidoc 不排除 exclude_patterns [重复]
【发布时间】:2020-01-12 14:09:39
【问题描述】:

我的目录结构如下:

+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 docs makefile 中的所有内容)。

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

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

【问题讨论】:

    标签: python python-sphinx sphinx-apidoc exclusionpath


    【解决方案1】:

    似乎 conf.py 中的 exclude_patterns 不是用于 api-doc,而是用于(可能)make html。 解决方案是在命令行中运行 apidoc 的排除模式

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

    【讨论】:

      猜你喜欢
      • 2018-03-22
      • 2012-07-16
      • 1970-01-01
      • 1970-01-01
      • 2023-03-29
      • 1970-01-01
      • 1970-01-01
      • 2021-02-25
      • 1970-01-01
      相关资源
      最近更新 更多