web-dev-qa-db-ja.com

sphinx docでインスタンス属性を表示する方法

スフィンクスのドキュメントで変数var1およびvar2とそれらの初期値を自動的に表示する方法はありますか？

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

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

    def method(self):
       pass
pythondocumentationpython-sphinx
38
Meloun

変数はインスタンス変数であり、クラス変数ではありません。

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

しかし、私は 情報フィールド を使用して変数のドキュメントを含めることを好みます：

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

以下も参照してください。

50
mzjn