如何在sphinx中自动生成私有实例属性？

Question

我通常在__init__中初始化所有实例属性

def __init__(self):
"""
Initializer docstring.
"""
    self.test1 = None  #: test1 docstring
    self._test2 = None  #: test2 docstring
    self.test3 = None
    """test3 docstring"""
    self._test4 = None
    """test4 docstring"""

我希望记录我的所有实例属性，包括私有属性。

为了生成文档，我使用了以下代码：

.. automodule:: module_name
    :members:
    :member-order: bysource
    :show-inheritance:
    :private-members:
    :special-members:

然而，私有实例属性仍然被省略。我错过了什么？

我使用的是python2.7、Sphinx 1.2.3和sphinx-rtd-theme 0.1.9。

提前谢谢你。

Answer 1

我运行了一些额外的测试，但仍然无法生成私有属性的文档。我没有时间去运行autodoc代码来验证问题是否出在我这一边，或者这只是一个设计师的选择。我想出了以下工作(以防其他人遇到类似的问题)：

1. 我记录了docstring类中的所有公共属性(按照NumPy风格的建议)。
2. 我使用变量的表示法记录了__init__ docstring中的所有私有属性(就像我在那里初始化它们一样)：

:ivar _private_attribute:描述。:vartype _private_attribute: int

因此，私有属性在变量一节中进行了说明。它不是完美的，但对我来说是有效的。