Sphinx autodoc integrates decorated properties

I started using Sphinx to document my sqlalchemy based application.

One of the typical uses of SA in attribute handling is hybrid-property decorator.

Now my problem is that I am not getting a doc entry for name :

 class User(GeneralTable): '''User''' ... @hybrid_property def name(self): ''' User name :rtype: unicode ''' if self._name is None: return 'anonymous' else: return self._name @name.setter def name(self, name): ''' :type name: unicode ''' self._name = name 

changing hybrid_property to a standard property , I am documenting it.

Is there a way to extend Sphinx to accept with hybrid_property the same property behavior?

My current workaround is to put the name .. attribute:: in the doc class.

+4
source share

All Articles