Я написал класс 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:
Все в порядке, и в документе появляются a, prop и square.
Но если я попытаюсь задокументировать атрибуты и методы отдельно, sphinx скажет, что не может найти атрибут a, но он работает для опоры.
.. 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 для атрибутов, сообщаемых как None, что sphinx не isntantiate класс, поэтому существует разница между атрибутом класса (как опора) и атрибутом экземпляра (как). Но как я могу ссылаться на атрибут экземпляра в документе?
На самом деле атрибуты экземпляра находятся, если они явно не запрашиваются в первом файле. Например, это будет работать:
.. autoclass:: aclass.Aclass
:members:
Но это не
.. autoclass: aclass.Aclass
:members: a
