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 post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to