स्फिंक्स के लिए पाइथन डॉकस्ट्रिंग में चर के लिए एक प्रकार कैसे निर्दिष्ट करता है?

Question

आप इस तरह अजगर docstrings में मापदंडों का प्रकार निर्दिष्ट कर सकते हैं:

def __init__(self, canvas, segments): 
    """Class constructor. 

    :param canvas: the PDF canvas object 
    :param segment: The layer segments to be drawn. 

    :type canvas: `canvas.Canvas` 
    :type segments: list of str 
    """ 
    ... 

स्फिंक्स 'autodoc सुविधा के साथ

, इस पैरामीटर सूची पैदावार, और प्रत्येक पैरामीटर ठीक से उनके प्रकार के साथ टैग है।

लेकिन मैं उदाहरण गुणों के साथ ऐसा कैसे करूं? कुछ

class Path(object): 
    """ 
    :ivar edge_indices: The indices within `textured_points` of the places. 

    :type edge_indices: list of int 
    """ 

काम नहीं करता है। कोई एकल-शब्द:ivar के बाद टाइप कर सकता है लेकिन यहां, इसमें तीन शब्द होते हैं, इसलिए यह काम नहीं करेगा।

Answer 1

मुझे यह वही समस्या थी। जवाब vartype:

class Foo: 
    """ 
    :ivar edge_indices: description 
    :vartype edge_indices: list of int 
    """ 

Answer 2

http://www.sphinx-doc.org/en/stable/domains.html#info-field-lists पढ़ें और चर के लिए देखो, विशेषताएँ स्फिंक्स बिंदु दृश्य से चर हैं।

मेरी धारणा यह है कि आपको उन्हें विधि स्तर के बजाय कक्षा स्तर पर दस्तावेज़ करना होगा।