相关疑难解决方法(0)

使用sphinx的autodoc对属性进行Docstring继承

我有一个这样的课:

class MyBase(object):
   x = 3
   """Documentation for property x"""
Run Code Online (Sandbox Code Playgroud)

和另一个继承它的类:

class MyObj(MyBase):
   x = 0
Run Code Online (Sandbox Code Playgroud)

当我使用sphinx的autodoc生成文档时,MyObj.x没有记录.有没有办法从中继承docstring MyBase.x?我找到了DocInherit,但由于它使用了一个装饰器,它只适用于类方法.有什么方法可以用属性做到这一点?

python python-sphinx autodoc

2
推荐指数
1
解决办法
2843
查看次数

标签 统计

autodoc ×1

python ×1

python-sphinx ×1