本文介绍了在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配置为按该顺序输出它们。
我不知道有任何其他方法对成员进行分组。
这篇关于在Shinx中对方法文档字符串进行分组的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!
本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!