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中对方法文档字符串进行分组的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!
沃梦达教程
本文标题为:在Shinx中对方法文档字符串进行分组


基础教程推荐
猜你喜欢
- 合并具有多索引的两个数据帧 2022-01-01
- 使 Python 脚本在 Windows 上运行而不指定“.py";延期 2022-01-01
- 症状类型错误:无法确定关系的真值 2022-01-01
- 哪些 Python 包提供独立的事件系统? 2022-01-01
- 如何在Python中绘制多元函数? 2022-01-01
- Python 的 List 是如何实现的? 2022-01-01
- 如何在 Python 中检测文件是否为二进制(非文本)文 2022-01-01
- 将 YAML 文件转换为 python dict 2022-01-01
- 使用 Google App Engine (Python) 将文件上传到 Google Cloud Storage 2022-01-01
- 使用Python匹配Stata加权xtil命令的确定方法? 2022-01-01