将类实例记录为函数

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()