如何在 Sphinx 中记录 Python 类的私有属性

问题描述 投票:0回答:0

我想将 Python 类的私有属性的描述添加到该类的 Sphinx 文档字符串中以提高代码可读性,但我希望自动生成的文档不显示这些属性。我可以这样做吗?

例如,如果我有这样的类和文档字符串:

class Foo:
'''
My class description

:ivar attr1: Attribute 1 description
:ivar attr2: Attribute 2 description
'''

我想在属性列表中添加一个私有属性 __attr3,我该怎么做?

我看到有一个“:meta private:”字段,如here所述,但这似乎是针对私有方法的。有没有办法将这个字段用于属性?

python python-sphinx sphinx docstring
© www.soinside.com 2019 - 2024. All rights reserved.