django - Sphinx 文档和 autodoc-skip-member

Question

我正在通过以下方式为 django 项目构建我的 sphinx 文档：

sphinx-apidoc app -o docs/source/app --force

现在它包括了我不想在我的文档中包含的所有南方迁移。我现在尝试通过以下方式排除它们：

conf.py:
    def skip_migrations(app, what, name, obj, skip, options):
        return skip or (what == 'module' and name.find('Migration') != -1)\ 
               or str(obj).find('migrations') != -1

    def setup(app):
       app.connect('autodoc-skip-member', skip_migrations)

现在它们不再被记录，但仍列在模块下。我怎样才能排除它们？

Answer 1

您可以通过将它们添加到 conf.py 文件中的 exclude_pattern 来排除为迁移创建的第一个文件：

exclude_patterns = ["**/*.migrations.rst",]

Answer 2

只是避免首先生成 .rst 文件sphinx-apidoc：

sphinx-apidoc app -o docs/source/app --force */migrations/*

在模块名称之后添加的模式被理解为排除路径。