I have a bunch of modules in a project for which all the documentation
is in the docstrings, and I am using
.. automodule:: mymodule
:members:
To build the documentation for the modules. However, some of these
modules have a variety of functions and classes, and the documentation
pages are getting rather long. Is there a way to include some sort of
summary before the automodule? Something like the output of
autosummary (with links to the docs on that page, instead of stub
pages) would be great, but the autosummary documentation seems to
imply that you have to explicitly state everything that gets a summary
- is there something like :members: that I can do for autosummary? Or
if I process the autodoc-process-docstring event, can I somehow insert
an autosummary at a specified point in the automodule?
Alternatively, A listing of all of the module members in the sidebar
would work - is there a way to do that without using stub pages?
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
