Sfinks: lista funkcji w module

Question

Mam kilka modułów python zawierających głównie funkcje i kilka klas. Każda z nich jest udokumentowana za pomocą sphinx-autodoc w oddzielnym pierwszym. Co chcę zrobić, to utworzyć tabelę lub listę treści modułu w górnej części każdej strony, tak na przykład, mymodule.py jest

def first(): 
    'First function' 

def second(): 
    'Second function' 

I mymodule.rst jest

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

:create_page_contents_list: 

Members 
------- 

.. automodule:: mymodule 
    :members: 

Następnie wyjście powinno wyglądać mniej więcej tak:

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

first 
second 

Members 
------- 

first() 
    First function 

second() 
    Second function 

na pytanie, jak zrobić :create_page_contents_list:. Rzuciłem okiem na używanie TOC, ale wydaje mi się, że musiałbym ręcznie utworzyć wpis dla każdego przedmiotu. Przyjrzałem się także autopodsumowaniu, ale wciąż muszę wymienić członków. Wszelkie sugestie dotyczące automatyzacji tego? Wolałbym unikać rozszerzeń stron trzecich.

Answer 1

Prawdopodobnie chcesz coś jak z autosummary extension. Rzeczywiste rozszerzenie autosummary nie będzie jednak robić tego, co chcesz.

Przykładem, jak można przedłużyć autosummary automatycznie wykryć zawartość modułu jest podana in this answer