Есть ли способ, как автоматически показывать переменные var1 и var2 и их init-значения в документации sphinx?
class MyClass:
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1 * 2
self.var2 = par2 * 2
def method(self):
pass
Ваши переменные являются переменными экземпляра, а не переменными класса.
Без присоединения строки документации (или #: "комментарий документа") к переменным они не будут документированы. Вы можете сделать следующее:
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
Смотрите также: