Hi Eric,

your question looks as if you are looking for autosummary:

  http://sphinx-doc.org/latest/ext/autosummary.html

Usage example:

  http://lino-framework.org/api/index.html
  https://github.com/lsaffre/lino/tree/master/docs

Luc


On 18/03/15 00:39, Eric Holscher wrote:
> Hi,
> 
> Does anyone know if there exists a way to get Sphinx to output a
> standard "javadoc" style API browser for a domain? I mostly just want a
> way to display all of the existing classes and methods, in a standard
> format with a basic hierarchy. All the data is there in the domain, I
> guess I'm more just wanting something like:
> 
> api/index.rst:
> 
> .. autopackage:: mypackage
> 
> Then this will generate a full set of HTML pages that is generated from
> that package. Instead of me having to have something like:
> 
> api/index.rst
> api/class1.rst
> api/class2.rst
> 
> I just want them all to be outputted at once. I know that sphinx-autogen
> exists, but I want it to just be a comprehensive set of all of a module
> by default.
> 
> I'll probably end up building this if one doesn't already exist. Even
> pointers at half-finished or attempts along these lines would be much
> appreciated.
> 
> Cheers,
> Eric
> 
> -- 
> 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]
> <mailto:[email protected]>.
> To post to this group, send email to [email protected]
> <mailto:[email protected]>.
> Visit this group at http://groups.google.com/group/sphinx-users.
> For more options, visit https://groups.google.com/d/optout.

-- 
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 http://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to