2013-05-08 4 views
6

Sto costruendo il mio sfinge doc per un progetto Django seguente modo:documentazione Sfinge e autodoc-saltare-membro

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

Ora include tutte le migrazioni Sud, che non vogliono avere a la mia documentazione Ora ho provato a escluderli in questo modo:

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) 

Ora non sono più documentati, ma sono ancora elencati in moduli. Come posso escluderli?

risposta

3

Si possono escludere i file creati per primi le migrazioni aggiungendoli alla exclude_pattern nel file conf.py:

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

Basta evitare di generare i file .rst con sphinx-apidoc, in primo luogo:

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

I motivi aggiunti dopo il nome del modulo sono considerati come percorsi esclusi.