Sphinx Ausgabe, Änderung Docstrings Ausgabeformat

Question

ich ein Beispiel unten Modell haben

class example(models.Model): 
    """This is the summary of the example 

    This is the description of the example 
    :param first: First parameter 
    :type filed1: String 
    :param second: Second parameter 
    :type field2: String 
    """  
    filed1 = models.DateTimeField(auto_now=True) 

Diese von Sphinx gerendert wird wie unten

class kyc_connect.models.example(*args, **kwargs)[source]¶ 

    This is the summary of the example 

    This is the description of the example :param first: First parameter :type filed1: String :param second: Second parameter :type field2: String 

dem heute alle param wirklich schlecht aussieht sind geronnen auf die einzelne Zeile. Ist dies das Standardverhalten oder mache ich etwas falsch, kann ich etwas tun, um die Ausgabe in einem anderen Format zu ändern?

Answer 1

Die Parameter in info field lists müssen mit Leerzeichen aus zwei Leerzeilen von der Beschreibung im Docstring getrennt werden.

class example(models.Model): 
    """This is the summary of the example 

    This is the description of the example 

    :param first: First parameter 
    :type field1: String 
    :param second: Second parameter 
    :type field2: String 
    """  
    filed1 = models.DateTimeField(auto_now=True) 

Ich reparierte auch die Typo für type field1.