如何獲得Sphinx自動摘要顯示實例屬性的文檔？

所有其他類型（類，屬性，方法等）都能正常工作，但當自動摘要獲取實例屬性時，會引發「WARNING: failed to import AClass.a」錯誤。奇怪的是表格是通過鏈接到下面的autodoc代碼文檔繪製的，但doc彙總列是空的。如何獲得Sphinx自動摘要顯示實例屬性的文檔？

有沒有人有這個工作，或有什麼想法可能是錯的？

顯示與鏈接表，但沒有文檔： enter image description here

可見，車博士是工作（沒有它上面的鏈接是不可能的）： enter image description here

我也試過其他形式的文檔，例如#: ...樣式等。所有相同的結果。再次，同一模塊中的其他所有內容都可以工作我看到在自動摘要表格文檔的方法等

Example類：

class AClass(object): 
    def __init__(self): 
     self.a = 10 
     """ 
     An example instance attribute 

     :type: int 
     """

實例休息：

.. autosummary:: 

    AClass.a

我使用的是獅身人面像1.2.3

來源

2015-04-27 Rafe

任何人都可以使用> 1500 rep爲autosummary或sphinx-autosummary或osme添加標籤嗎？也許一個autodoc呢？ – Rafe

這是我現在的感覺：https：//xkcd.com/979/仍然沒有解決方案？ :( – mcocdawc

不幸的是，autosummary根本不支持這一點。代碼，重要的一點是sphinx.ext.autosummary.__init__.AutoSummary.get_items基本上是：

for name in names: 

    # <snip> 

    try: 
     real_name, obj, parent, modname = import_by_name(name, prefixes=prefixes) 
    except ImportError: 
     self.warn('failed to import %s' % name) 
     items.append((name, '', '', name)) 
     continue

name是你想作一個總結的autosummary指令下的東西，所以你的情況是"AClass.a"。但是，由於實例屬性不可導入，並且import_by_name嘗試導入名稱，因此失敗。我不知道爲什麼實施者這樣做，但我們走了。

如果你有時間和傾向，應該可以解決這個問題！我已打開an issue來跟蹤它。

來源

2016-12-17 12:03:43 daphtdazz

如何獲得Sphinx自動摘要顯示實例屬性的文檔？

回答

相關問題