Python Sphinx Autosummary: Automated listing of member functions

Viewed 10010

How can I tell the autosummary extension not to only list a single class but also all the class' members?

If I use:

.. autosummary::

    MyClass

In the resulting html file, there will only be one short summary like:

MyClass(var1, var2,....) My Custom class to do fancy things...

What I actually want is something like:

MyClass(var1, var2,....) My Custom class to do fancy things...

MyClass.doA(var1, var2, ...) Does A very well

MyClass.doB(var1, var2, ...) Does B even better

How do I have to configure the autosummary directive in order to get this (apart from tediously naming all functions myself in the autosummary directive)? Thanks!

3 Answers
Related