Sphinx: lista de funciones en un módulo

Question

Tengo algunos módulos de python que contienen principalmente funciones y algunas clases. Cada uno está documentado usando sphinx-autodoc en un primer momento. Lo que quiero hacer es crear una lista o tabla de contenidos del módulo en la parte superior de cada página, así que por ejemplo, de mymodule.py es

def first(): 
    'First function' 

def second(): 
    'Second function' 

Y mymodule.rst es

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

:create_page_contents_list: 

Members 
------- 

.. automodule:: mymodule 
    :members: 

a continuación, la salida debería ser algo como esto:

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

first 
second 

Members 
------- 

first() 
    First function 

second() 
    Second function 

la pregunta de cómo hacer :create_page_contents_list:. He echado un vistazo al uso de un TOC, pero parece que necesitaría crear manualmente una entrada para cada artículo. También he analizado autosummary, pero todavía necesito enumerar a los miembros. ¿Alguna sugerencia para automatizar esto? Prefiero evitar extensiones de terceros.

Answer 1

Probablemente desee algo comoautosummary extension. Sin embargo, la extensión autosummary real no hará exactamente lo que usted desea.

Un ejemplo de cómo se puede extender Autorresumen de detectar automáticamente los contenidos del módulo se da in this answer