Sphinx Dokumentation und Autodoc-skip-Mitglied

Question

ich meine Sphinx doc für ein django Projekt die folgende Art und Weise den Aufbau:

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

Jetzt ist es alle der Süd-Migration umfasst, die will ich nicht in haben meine Dokumentation. Ich habe jetzt versucht, sie auf folgende Weise auszuschließen:

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) 

Jetzt sind sie nicht mehr dokumentiert, werden aber immer noch unter Module aufgelistet. Wie kann ich sie ausschließen?

Answer 1

Sie können die ersten Dateien für die Migration erstellt ausschließen, indem sie auf die exclude_pattern in Ihrer conf.py Datei hinzufügen:

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

Answer 2

vermeiden Sie die .rst Dateien mit sphinx-apidoc in erster Linie zu erzeugen:

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

Muster, die nach dem Modulnamen hinzugefügt wurden, werden als ausgeschlossene Pfade verstanden.