comment afficher les attributs d'instance dans sphinx doc?

Question

Existe-t-il un moyen d'afficher automatiquement les variables var1 et var2 et leurs valeurs init dans la documentation de sphinx?

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

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

    def method(self):
       pass

Answer 1

Vos variables sont des variables d'instance, pas des variables de classe.

Sans attacher une docstring (ou un #: "doc comment") aux variables, elles ne seront pas documentées. Vous pouvez procéder comme suit:

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

Mais je préférerais inclure une documentation variable en utilisant champs info :

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

Voir également:

• http://www.sphinx-doc.org/ext/autodoc.html#directive-autoattribute
• Comment puis-je faire que les attributs d'objet de document Python/Sphinx ne soient déclarés que dans __init __?
• Problèmes avec l'autodoc et les attributs d'instance explicitement spécifiés