我编写了一个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
现在,为了进行文档编写,在rst文件中我写下了以下内容:
.. autoclass:: aclass.Aclass
:members:
一切都没问题,文档中出现了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
我在某个地方读到了一篇关于Sphinx的文章《Sphinx values for attributes reported as None》,其中提到sphinx不会实例化类,因此类属性(作为prop)和实例属性(作为a)之间存在差异。但是我该如何在文档中引用实例属性呢?
实际上,如果在rst文件中没有明确要求,实例属性也会被找到。例如,以下代码可以正常工作:
.. autoclass:: aclass.Aclass
:members:
但这并不是
.. autoclass: aclass.Aclass
:members: a