I am very new to sphinx and am having a problem... I use the autodoc extension and for each of my modules I have a .rst file like:
:mod:`util` Module ============================== .. automodule:: lib.util This is ok but lib.util contains several dozen classes and functions, each with a detailed doc- string. The result is a very large HTMl file that one has to do a lot of scrolling through to find what one is looking for. Finding things is even worse because I use the "autodoc_member_order='bysource'" config option. I would like a small table at the top of the resulting html file, one line per class/function, with a clickable link to the class or function that is documented in full later in the file. (Having a separate ToC file with a maxdepth that shows the module contents is not a good solution in this environment; I want a class/function list at the top of the full doc file like one sees with FAQs where a list of question links is at the top followed by the all the full question/answers.) I tried adding an autosummary directive to the .rst file above, but it seems autosummary requires me to explicitly list every class/function which rather defeats the "auto" part! Since this seems like a common need I'm guessing there is a well-known solution that I am just not seeing. A clue would be appreciated. -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
