如何在Sphinx autodoc中重命名类

时间:2019-11-12 18:00:15

标签: python-sphinx autodoc

我对Sphinx文档框架有疑问。 我正在编写类似熊猫的库,并且有一个.str访问器的类似物,它是由私有类(例如_StrAccess)实现的。

所以我想使用它的方法,例如str.match,文档的str.lower部分。但是我找不到合适的文档。

现在将其自动标记为:

class module.column._StrAccess

def match()

def lower()

我希望它是

accessor module.column.str

def match()

def lower()

我已经尝试过使用事件更改签名,并且可以修改管道,但只能得到错误和尴尬的行为。 :)

正确的做法是什么?

0 个答案:

没有答案