Sphinx autosummary没有显示属性摘要

Question

我使用Sphinx==1.6.3使用sphinx-build -a docs/source docs/build构建我的文档，并在conf.py中列出的扩展名中包含sphinx.ext.autosummary。我想要一个类似于pandas.DataFrame

的方法和属性的摘要

我使用@property装饰器定义了一个数字属性：

class Model(object):
    def __init__(self):
        self._X = None

    @property
    def X(self):
        '''
        :Getter: Returns X
        '''
        return self._X

Sphinx将构建文档，构建方法摘要，将使用其他方法列出属性，但不会生成属性摘要。

我是否需要明确指示Sphinx将属性作为自动摘要的一部分包含在内？

Answer 1

包含使用类似于Pandas的@property装饰器记录的属性，您需要利用numpydoc包并在{{}的扩展名列表中添加numpydoc 1}}