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

You may exclude the rst files created for the migrations by adding them to the exclude_pattern in your conf.py file:

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