將類實例記錄爲函數

Question

使用sphinx autodoc擴展名創建文檔時如何將類實例（不是類本身）記錄爲函數？類定義了一個__call__方法。

Answer 1

有可能使用的獅身人面像的擴展來解決這個問題。對我來說，以下是足夠：

1. 在conf.py：

   1. 添加適當的路徑sys.path在conf.py
   2. 在extensions列表

2. 與新的模塊名稱替換sphinx.ext.autodoc新模塊：

   1. 進口sphinx.ext.autodoc
   2. 創建的.autodoc.FunctionDocumenter
   3. 一個子類創建setup(app)函數調用.autodoc.setup()，然後調用app.add_autodocumenter(SubclassName)

注意，這將取代文檔管理器功能，因此您需要使它對他們有用。通過定義objtype類常量和唯一的字符串作爲值可以避免該問題，但這需要更多的工作。關心常規功能更容易。如果有人感興趣，代碼是here。

Answer 2

我不熟悉autodoc特別，但你可以試試這個：

class MyClass(object): 
    ... 
    def __call__(self): 
     ... 

c = MyClass() 
""" 
this is a function-like object. 
""" 

c2 = MyClass() 
""" 
this is another function-like object. 
""" 

或者這樣：

#: this is a function-like object. 
c = MyClass()