python - 狮身人面像中的组方法文档字符串

标签 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 应该一起列出。

最佳答案

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

我不知道有任何其他方式可以对成员进行分组。

关于python - 狮身人面像中的组方法文档字符串,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/17193143/

相关文章:

python - 如何使用 Intersphinx 引用特定文档中的类?

python - Pandas :按两列分组并计算第二列所有值的出现次数

python - 将 Pyspark RDD 拆分为不同的列并转换为 Dataframe

python - 在 Sphinx 中记录带有长描述的参数

python - Autodoc Sphinx 出现 django 错误

python - 如何让 Sphinx 自动摘要显示实例属性的文档?

python - 狮身人面像自定义模板

python - Scrapy递归链接爬虫

python - 使用 OpenCV 检测正方形/矩形

Python:尝试将函数参数传递给类中的另一个函数,得到 NameError:未定义名称 ' '