comment afficher les attributs d'instance dans sphinx doc?
Est-il un moyen d'afficher automatiquement les variables var1 et var2 et de leurs valeurs d'initialisation dans le sphinx de la documentation?
class myClass():
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1
self.var2 = par2
def method():
pass
29
demandé sur
Meloun
2011-12-28 00:43:24
1 réponses
Vos variables sont des variables d'instance, pas des variables de classe.
Sans attacher un docstring (ou un #: "doc comment") aux variables, elles ne seront pas documentées. Vous pourriez faire 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 la documentation des variables en utilisant 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
Voir aussi:
41
répondu
mzjn
2017-05-23 12:10:05