Is it possible to use autosummary on all methods of a class or module?

133 views
Skip to first unread message

Mortada Mehyar

unread,
Nov 8, 2013, 2:42:59 PM11/8/13
to sphin...@googlegroups.com

Hi,

Here's an example from the online documentation page for sphinx: http://sphinx-doc.org/ext/autosummary.html

.. currentmodule:: sphinx

.. autosummary::

   environment.BuildEnvironment
   util.relative_uri

But this seems to require manually listing each individual function for autosummary to include. I'd like to include all methods/functions within the module or within a class defined in the module, similar to what autodoc can do with

.. automodule::
    :members:
    :undoc-members:

Is that possible with autosummary?

Thank you.

Nick Janssen

unread,
Aug 10, 2016, 8:20:38 AM8/10/16
to sphinx-dev
Hi, 

did you find a solution to your problem?

Nick
Reply all
Reply to author
Forward
0 new messages