Sphinx文档和autodoc-skip-member

Question

我正在通过以下方式为Django项目构建我的狮身人面像文档：

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

仅避免首先以sphinx-apidoc生成.rst文件：

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

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