Crea automaticamente un toctree per le classi di auto doc in Sfinge

Question

Sto cercando di aumentare la documentazione in una delle mie librerie. Ho usato la sfinge per aiutare a costruire la documentazione e recentemente ho iniziato a esplorare l'estensione dell'autodoc.

Sembra che nella maggior parte della documentazione professionale, ogni pagina di documentazione della classe abbia un elenco di tutti i metodi documentati con collegamenti in alto. O, in altre parole, un toctree in alto con collegamenti ipertestuali a ciascuna della documentazione del metodo più approfondita.

C'è un modo per creare automaticamente questo toctree per ciascuna delle classi documentate con autodoc?

Answer 1

Nel file conf.py per sfinge aggiungere

extensions = ['sphinx.ext.autosummary',] 
# NOTE: Don't overwrite your old extension list! Just add to it! 

autodoc_default_flags = ['members'] 
autosummary_generate = True 

ho messo la toctree nel mio index.rst, e sembra che questo:

..autosummary:: 
    :toctree: stubs 

    Class1 
    Class2 
    Class3 

Vedere this example per le impostazioni conf.py

e this example per un esempio del toctree.

Spero che questo aiuti!