像epyd一样在sphinx中创建类概述

2024-04-24 21:31:45 发布

您现在位置:Python中文网/ 问答频道 /正文

Epydoc早就停止了开发,它曾经提供了一个非常强大的类或模块概述。例如:

enter image description here

注意,它用doc字符串的第一行左右显示了模块中的类。对于函数,它还显示了函数原型以及doc字符串的开头和指定的可选参数。你知道吗

这在浏览文档时非常有用,因为可以查看合理命名的类/模块,并轻松找到适当的函数或方法。你知道吗

我想在狮身人面像有类似的功能,但我找不到任何例子来证明这一点。坦白地说,我有点惊讶,因为在所有关于斯芬克斯的赞美之海中,似乎没有人关心这个特征缺席,或者至少据我所知缺席。你知道吗

有人知道有没有办法复制像斯芬克斯中所示的图像?你知道吗


Tags: 模块方法函数字符串文档功能证明参数