sphinx中的组方法docstrings

时间:2013-06-19 13:55:01

标签: python python-sphinx

是否可以使用sphinx将多个方法文档字符串与autodoc功能组合在一起,以便将它们列在一起?

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."""

在生成的文档中,a和d应该一起列出,以及b和c。

1 个答案:

答案 0 :(得分:1)

将方法分组在源模块中,并使用autodoc_member_order = 'bysource'将Sphinx配置为按顺序输出。

我不知道任何其他组成员的方式。