CODEWITHSUNDEEP
pythonpython-sphinx
P3trus
P3trus

Reputation: 7215

Group method docstrings in sphinx

Is it possible to group several method docstrings with sphinx using it's autodoc capabilities, so that they are listed together?

class Test(object):
    def a(self):
        """A method of group foo."""

    def b(self):
        """A method of group bar."""

    def c(self):
        """A method of group bar."""

    def d(self):
        """A method of group foo."""

In the generated documentation a and d should be listed together, aswell as b and c.

Upvotes: 4

Views: 1109

Answers (1)

mzjn
mzjn

Reputation: 50947

Group the methods in the source module and configure Sphinx to output them in that order, using autodoc_member_order = 'bysource'.

I am not aware of any other way to group members.

Upvotes: 3

Related Questions