cómo mostrar atributos de instancia en sphinx doc?

Question

¿Hay alguna manera de mostrar automáticamente las variables var1 y var2 y sus valores init en la documentación de sphinx?

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

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

    def method(): 
     pass 

Answer 1

Sus variables son variables de instancia, no de clase.

Sin adjuntar una docstring (o un #: "comentario de documento") a las variables, no se documentarán. Se podría hacer de la siguiente manera:

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 

Pero yo preferiría incluir documentación variable utilizando 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 

Ver también:

• 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