Sphinx kullanarak bir Python özellik belirleyicisi için nasıl belge üretebilirim?

Question

Ben Sphinx dökümanlara göre dönüştürülmesi amaçlanan Docstringler ile aşağıdaki gibi bir Python sınıfı şey vardır:

class Direction(object): 
    """ 
    A direction in which movement can be made. 
    """ 
    def __init__(self): 
     self._name = None 

    @property 
    def name(self): 
     """ 
     The unique name of the direction. 

     :return: The direction name 
     :rtype: string 
     """ 
     return self._name 

    @name.setter 
    def name(self, value): 
     """ 
     Sets the direction name. 

     :param string value: The direction name 
     """ 
     self._name = value 

Sfenks çıktı şuna benzer:

sınıfYön (isim) Hareketin yapılabileceği bir yön.

adı yön benzersiz bir isimdir.

İade: yön adı

Dönüş türü: olarak gittiği yere kadar gayet dize

, ancak herhangi bir bilginin tam olmadığına dikkat name setter hakkında.

Sphinx'in özellik ayarlayıcı için belge üretmesini sağlamanın bir yolu var mı?

Answer 1

Sfenks mülkiyet ayarlayıcıları Docstringler yüzden bir özellik için tüm belgeler @property yöntemine olmalıdır yok sayar. Sphinx, belirli belirli etiketleri (örneğin, :param ...:) anladığı sırada, herhangi bir özel etiketi kabul eder ve bunları takip eden metnin etiketleri olarak işleyecektir.

nedenle makul bir şekilde belgelere hale getirecek aşağıdaki gibi bir şey (gerekirse getter, setter ve type başka metne değiştirilebilir) .

sınıfYön (isim) hareketi yapılabilir hangi bir yönü:

@property 
def name(self): 
    """ 
    The unique name of the direction. 

    :getter: Returns this direction's name 
    :setter: Sets this direction's name 
    :type: string 
    """ 
    return self._name 

oluşturulan belgeler şuna benzer.

adı yön benzersiz bir isimdir.

Getter: İade bu yönde adı

Setter: Setleri bu yönde adı

Tür: dize

T Bu çözüm yönünde beni işaret ettiği için @BrenBarm ve @ A-B-B'ye hanks.