4

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

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 一起列出。

4

1 回答 1

2

将源模块中的方法分组并配置 Sphinx 以按顺序输出它们,使用autodoc_member_order = 'bysource'.

我不知道有任何其他方式来分组成员。

于 2013-07-09T10:42:56.870 回答