'How to show instance attributes in sphinx doc?
Is there any way to automatically show variables var1 and var2 and their init-values in sphinx documentation?
class MyClass:
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1 * 2
self.var2 = par2 * 2
def method(self):
pass
Solution 1:[1]
For Python 3.9+ dataclass style classes you can do
@dataclass
class MyClass:
#: Nice vars!
var1: int = 0
#: Life is beautiful, remember to buy flowers for your wife
var2: int = 0
Sources
This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.
Source: Stack Overflow
| Solution | Source |
|---|---|
| Solution 1 |
