獅身人面像自動摘要未顯示屬性摘要

我使用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

獅身人面像將建立文檔，建立一個彙總的方法，將列出屬性與其他方法一起使用，但不會做出屬性摘要。

我是否需要明確指示獅身人面像包含屬性作爲自動彙總的一部分？

來源

2017-08-03 Jørgen

如果我正確理解你的問題Pandas的@property裝飾文檔的屬性，這聽起來類似這樣的獅身人面像問題，[文件在裝飾功能沒有生成]（https://github.com/sphinx-doc/sphinx/issues/3783）。如果沒有，還有其他幾個包含[「裝飾者」]的開放問題（https://github.com/sphinx-doc/sphinx/issues?utf8=%E2%9C%93&q=decorator）。 –

包括利用類似，你需要利用numpydoc包，包括numpydoc在擴展列表中conf.py

來源

2017-09-05 16:03:31

獅身人面像自動摘要未顯示屬性摘要

回答

相關問題