Python 如何在sphinx文档中显示实例属性？

有没有办法在sphinx文档中自动显示变量var1和var2及其初始值

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

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

    def method(self):
       pass

---

您的变量是实例变量，而不是类变量

如果不将docstring（或

#:

“doc comment”）附加到变量，它们将不会被记录。你可以这样做：

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

但我更愿意通过以下方式包括可变文档：

另见：

---

sphinx在html页面中显示#：文档注释所需的任何设置？我使用sphinx apidoc命令生成.rst文件。@varunsinghal:有问题吗？我对私有类变量使用了这些文档注释#：回答得很好！您不需要使用

：ivar foo:

，只要

：var foo

就可以了。@raylo它们不是同义词-

ivar

=实例变量，

cvar

=类变量，

var

=自己解决。斯芬克斯并不在意，但它告诉了人类读者。

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