Sphinx Autodoc объединяет декорированные свойства - PullRequest
Новая
       35

Sphinx Autodoc объединяет декорированные свойства

6 голосов
/ 28 июля 2011

Я начал использовать 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:: в User class doc.

...