[英]Group method docstrings in 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。
將源模塊中的方法分組,並使用autodoc_member_order = 'bysource'
配置Sphinx以此順序輸出它們。
我不知道任何其他組成員的方式。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.