dokumentacja Sphinx i AutoDoc-skip-członek

Question

buduję moją sfinks doc dla projektu django następujący sposób:

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

Teraz obejmuje wszystkie Południowej migracje, które nie chcą mieć w moja dokumentacja. I teraz próbował wykluczyć je w następujący sposób:

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) 

Teraz już nie są udokumentowane, ale nadal są wymienione w modułach. Jak mogę je wykluczyć?

Answer 1

można wykluczyć RST plików utworzonych za migracje, dodając je do exclude_pattern w conf.py pliku:

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

Answer 2

Wystarczy uniknąć generowania .rst pliki sphinx-apidoc w pierwszej kolejności:

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

Wzory dodane po nazwie modułu są rozumiane jako wykluczone ścieżki.