当我使用 Sphinx autodoc 来记录一个类时,总是会报告属性的值(正如它所说的那样 here,在 #437 下)但总是“= None”
Attribute = None
Some Documentation
我把它包括在内
.. autoclass:: core.SomeClass
:members:
我的代码看起来像
class SomeClass(object):
def __init__(self):
self.attribute = "value" #: Some Documentation
有没有办法让“= None”报告真实值,或者让它消失?
最佳答案
会有一个:annotation:
即将推出的 sphinx 1.2 版(以及第二个测试版)中的选项(请参阅 pull-request)。
对于 autodata
/autoattribute
然后你可以强制一个特定的值或抑制它。
因此,为了不打印属性的值,您将放置:
.. autoclass:: core.SomeClass
.. autoattribute:: attribute
:annotation:
目前它只适用于 autodata
/autoattribute
直接而不是递归地使用 automodule
/autoclass
.
关于python - 属性的 Sphinx 值报告为无,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/9153473/