python - 使用 sphinx 的 autodoc 的属性文档字符串继承

Question

我有这样一个类:

class MyBase(object):
   x = 3
   """Documentation for property x"""

和另一个继承它的类:

class MyObj(MyBase):
   x = 0

当我使用 sphinx 的 autodoc 生成文档时，MyObj.x 没有记录。有什么方法可以从 MyBase.x 继承文档字符串吗？我找到了 DocInherit但是因为它使用了装饰器，所以它只适用于类方法。有什么方法可以用属性来做到这一点？

Answer 1

我找到了使用属性函数的解决方法:

class MyBase(object):
   _x = 3
   x = property( lambda s: s._x, doc="Documentation for property x")

class MyObj(MyBase):
   _x = 0

这很好，因为给定了一个实例变量:

>>> m = MyObj()
>>> m.x
0

可以调用 help(m) 并获得属性 x 的正确文档，sphinx 也可以正确地选择它。