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

首先避免使用sphinx-apidoc生成.rst文件：

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

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

Sphinx文档和autodoc-skip-member

2 个答案: