sphinx दस्तावेज़ में इंस्टेंस विशेषताएँ कैसे दिखाना है?

Question

क्या कोई तरीका है कि स्वचालित रूप से वेरिएबल्स var1 और var2 और स्फिंक्स दस्तावेज़ों में उनके इनिट-वैल्यू कैसे हैं?

class myClass(): 
    """  
    Description for class 
    """ 

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

    def method(): 
     pass 

Answer 1

आपके चर आवृत्ति चर हैं, कक्षा चर नहीं।

चर के लिए एक डॉकस्ट्रिंग (या #: "डॉक्टर टिप्पणी") को जोड़ने के बिना, उन्हें दस्तावेज नहीं किया जाएगा। इस प्रकार आप कर सकता है:

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 

लेकिन मैं info fields का उपयोग करके चर दस्तावेज शामिल करना पसंद करेंगे:

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
• How can I make Python/Sphinx document object attributes only declared in __init__?
• Problems with autodoc and explicitly specified instance attributes