Sphinx autodoc集成了装饰属性

时间:2011-07-28 12:45:47

标签: python sqlalchemy properties decorator python-sphinx

我开始使用Sphinx来记录我的sqlalchemy驱动的应用程序。

SA在属性操作中的一个典型用法是使用hybrid-property装饰器。

现在我的问题是我没有获得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

hybrid_property更改为标准property时,我会将其记录下来。

有没有办法扩展Sphinx以采用hybrid_property相同的property行为?

我目前的解决方法是在.. attribute::类doc中添加名称User

0 个答案:

没有答案