I'm also looking for this. Essentially I want what http://golang.org/pkg/ has, where if you click through to one of the (auto-generated) packages, for example bytes <https://golang.org/pkg/bytes/>, you can see the entire public API at a glance. From the Sphinx perspective I think this would mean treating directives like ".. func::" and ".. class::" as subheadings that get added to the table of contents. Any pointers? Is this something I could accomplish by modifying our domain code <https://github.com/dylan-lang/sphinx-extensions/blob/master/sphinxcontrib/dylan/domain/dylandomain.py> to somehow add ToC entries?
On Friday, January 25, 2019 at 12:53:35 PM UTC-5 johna318 wrote: > I’m a sphinx newbie and I’m now moving from autodoc to autosummary. As > of now I’m pretty confused about the latter. > > > What I want to do is generate html files for each module in a large > library such that each module html file contains a summary table at that > lists all the global variables, functions and classes (including methods > etc.) defined in the file, similarly to what Javadoc does, though probably > in a simplified form. > > > Further, I want to do this at the config and maybe template level, without > having to explicitly list modules or items within modules – same as autodoc > –, so that when I run sphinx-apidoc and sphinx it will find everything it > needs to put in the summaries automatically. I want this because the > library is constantly evolving as new nodules are added to the library and > new functions and methods are added to the modules. > > > Is this possible? Or maybe better, how much of what I want can I get? Also > is there sample code out there that does what I describe or at least > something similar to it. > > > -- John > -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/d1234af5-aa4f-4a4e-8b5c-da57bf066472n%40googlegroups.com.
