KnowledgeHub
Questions
Tags
Users
Search
Alex Rivera
|
Logout
Edit Question
Title
Body
I have some python modules containing mostly functions and a few classes. Each one is documented using sphinx-autodoc in a separate rst. What I want to do is to create a table or list of the module's contents at the top of each page, so for example, of mymodule.py is def first(): 'First function' def second(): 'Second function' And mymodule.rst is Page Contents ------------- :create_page_contents_list: Members ------- .. automodule:: mymodule :members: Then the output should look something like this: Page Contents ------------- first second Members ------- first() First function second() Second function The question how to do :create_page_contents_list: . I've have a look at using a TOC, but it seems that I would need to manually create an entry for each item. I've also looked at autosummary, but I still need to list the members. Any suggestions for automating this? I'd rather avoid third-party extensions.
Tags (comma-separated)
Save Edits
Cancel