Hello,
what is regarded as the most effective way to create an overview of
all functions contained in a package?

I am thinking of something like autosummary [1, 2] which creates a
summary like [2] for all functions contained with different modules is
a package.

Currently, autosummary and autodoc can auto document single modules
like


.. currentmodule:: scikits.timeseries.lib.reportlib

.. autoclass:: Report

These directives always require to specify the module name.
Is there possibility to recursively auto document all modules in a
package?

Example:

mypackage.mod1
mypackage.mod2

I would like to have: mypackage.html which includes all functions of
mod1 & mod2 and eventually further modules added at later stage.

Thanks in advance,
Timmie


[1] http://projects.scipy.org/numpy/browser/trunk/doc/sphinxext/autosummary.py
[2] http://docs.scipy.org/doc/numpy/reference/routines.statistics.html

--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---

Reply via email to