Sfinge: elenco di funzioni in un modulo

Question

Ho alcuni moduli python contenenti principalmente funzioni e alcune classi. Ognuno è documentato usando sphinx-autodoc in un primo separato. Quello che voglio fare è quello di creare una tabella o un elenco del contenuto del modulo nella parte superiore di ogni pagina, così per esempio, di mymodule.py è

def first(): 
    'First function' 

def second(): 
    'Second function' 

E mymodule.rst è

Page Contents 
------------- 

:create_page_contents_list: 

Members 
------- 

.. automodule:: mymodule 
    :members: 

l'uscita dovrebbe essere simile a questa:

Page Contents 
------------- 

first 
second 

Members 
------- 

first() 
    First function 

second() 
    Second function 

la domanda come fare :create_page_contents_list:. Ho dato un'occhiata all'utilizzo di un sommario, ma sembra che avrei bisogno di creare manualmente una voce per ogni elemento. Ho anche guardato l'autosummary, ma ho ancora bisogno di elencare i membri. Qualche suggerimento per automatizzare questo? Preferisco evitare le estensioni di terze parti.

Answer 1

Probabilmente si desidera qualcosa come il autosummary extension. L'attuale estensione di riassunto automatico non farà esattamente quello che vuoi, però.

Un esempio di come si potrebbe estendere AutoSummary di rilevare automaticamente il contenuto del modulo è dato in this answer