在Shinx中对方法文档字符串进行分组

Group method docstrings in sphinx(在Shinx中对方法文档字符串进行分组)
本文介绍了在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中对方法文档字符串进行分组的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Leetcode 234: Palindrome LinkedList(Leetcode 234:回文链接列表)
How do I read an Excel file directly from Dropbox#39;s API using pandas.read_excel()?(如何使用PANDAS.READ_EXCEL()直接从Dropbox的API读取Excel文件?)
subprocess.Popen tries to write to nonexistent pipe(子进程。打开尝试写入不存在的管道)
I want to realize Popen-code from Windows to Linux:(我想实现从Windows到Linux的POpen-code:)
Reading stdout from a subprocess in real time(实时读取子进程中的标准输出)
How to call type safely on a random file in Python?(如何在Python中安全地调用随机文件上的类型?)