Czy jest jakiś sposób, aby automatycznie wyświetlić zmienne var1 i var2 i ich wartości początkowe w dokumentacji Sphinx?jak wyświetlić atrybuty instancji w dokumencie Sphinx?
class myClass():
"""
Description for class
"""
def __init__(self, par1, par2):
self.var1 = par1
self.var2 = par2
def method():
pass
Twoje zmienne to zmienne instancji, a nie klasy.
Bez dołączania do zmiennych dokumentu docstring (lub "komentarza do dokumentu" #:), nie będą one dokumentowane. Można to zrobić w następujący sposób:
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
Ale wolałbym zawierać zmienną dokumentacji za pomocą 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
Patrz także:
Jakieś ustawienie wymagane dla #: doc komentarz, aby był widoczny na stronach html przez sfinksa? Użyłem polecenia sphinx-apidoc do wygenerowania plików .rst. – varunsinghal
@varunsinghal: czy jest jakiś problem? – mzjn
Użyłem tych komentarzy do dokumentów #: dla prywatnych zmiennych klasowych. – varunsinghal