如何在sphinx doc中显示实例属性？

Question

有没有办法如何在sphinx文档中自动显示变量var1和var2及其init-values？

class MyClass:
    """    
    Description for class
    """

    def __init__(self, par1, par2):
       self.var1 = par1 * 2
       self.var2 = par2 * 2

    def method(self):
       pass

Answer 1

您的变量是实例变量,而不是类变量.

如果不将文档字符串(或#:"doc注释")附加到变量,则不会记录它们.你可以这样做:

class MyClass(object):
    """    
    Description for class 

    """

    def __init__(self, par1, par2):
        self.var1 = par1 #: initial value: par1
        self.var2 = par2 #: initial value: par2

    def method(self):
        pass

但我更喜欢使用信息字段包含变量文档:

class MyClass(object):
    """    
    Description for class

    :ivar var1: initial value: par1
    :ivar var2: initial value: par2
    """

    def __init__(self, par1, par2):
        self.var1 = par1 
        self.var2 = par2 

    def method(self):
        pass

也可以看看:

• http://www.sphinx-doc.org/ext/autodoc.html#directive-autoattribute
• 如何创建仅在__init__中声明的Python/Sphinx文档对象属性？
• autodoc和显式指定的实例属性的问题