autodoc 和明确指定的实例属性的问题

Question

我写了一个 python 类，并用 sphinx 制作了文档。例如，该类如下所示：

class Aclass(object):
    """ my class """

    def __init__(self):
        """ constructor """

        self.a = None
        """ doc for attribute a """

        self._prop = None

    def _get_prop(self):
        """ getter prop """
        return self._prop

    def _set_prop(self, val):
        """ setter prop """
        self._prop = val

    prop = property(_get_prop, _set_prop)
    """ a property """

    def square(self):
        """ return square of a """
        return self.a**2

现在，为了做文档，我在第一个文件中写道：

.. autoclass:: aclass.Aclass
   :members:

它的一切OK，并且a，prop和square出现在文档。

但是如果我尝试分别记录属性和方法，sphinx 会说它无法找到属性 a 但它适用于 prop。

.. autoattribute:: aclass.Aclass.prop

.. autoattribute:: aclass.Aclass.a

错误信息是：

Traceback (most recent call last):                                                                                
  File "/usr/lib/python2.7/dist-packages/sphinx/ext/autodoc.py", line 326, in import_object
    obj = self.get_attr(obj, part)
  File "/usr/lib/python2.7/dist-packages/sphinx/ext/autodoc.py", line 232, in get_attr
    return safe_getattr(obj, name, *defargs)
  File "/usr/lib/python2.7/dist-packages/sphinx/util/inspect.py", line 70, in safe_getattr
    raise AttributeError(name)
AttributeError: a

/home/gvallver/dev/sphinx/doc/source/index.rst:17: WARNING: autodoc can't import/find attribute 'aclass.Aclass.a', it reported error: "a", please check your spelling and sys.path

我在某处阅读了报告为 None 的属性的 Sphinx 值，Sphinx不会对类进行说明，因此类属性（作为道具）和实例属性（作为 a）之间存在差异。但是如何在文档中引用实例属性？

实际上，如果在 rst 文件中没有明确询问实例属性，就会找到它们。例如，这将起作用：

.. autoclass:: aclass.Aclass
    :members:

但这不

.. autoclass: aclass.Aclass
    :members: a

Answer 1

有一个关于此的错误报告（创建于 2012-03-30；仍于 2015-12-12 开放）：https ://github.com/sphinx-doc/sphinx/issues/904 。

1. 包含实例属性的显式列表的问题已在此提交:members:中修复（包含在 Sphinx 1.2b1 中）。

2. 正如评论（来自乔恩·沃尔特曼）中提到的，有一个未记录的autoinstanceattribute指令。

   使用.. autoinstanceattribute:: aclass.Aclass.a确实有效（使用 Sphinx 1.1.3 和 1.2b1 进行测试）。