在Shinx中对方法文档字符串进行分组
问题描述
是否可以使用Shinx的自动对接功能对多个方法文档字符串进行分组,以便将它们一起列出?
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一起列出。
解决方案
将源模块中的方法分组,并使用autodoc_member_order = 'bysource'
将Sphinx配置为按该顺序输出它们。
我不知道有任何其他方法对成员进行分组。
相关文章