Sphinx sortie, changement docstrings format de sortie

Question

J'ai un exemple ci-dessous le modèle

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) 

Ceci est rendu par Sphinx comme ci-dessous

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 

Ce qui semble vraiment mauvais étant donné tous les param sont coagulé la ligne unique. Est-ce le comportement par défaut ou je fais quelque chose de mal, puis-je faire quelque chose pour changer la sortie dans un format différent?

Answer 1

Les paramètres de info field lists doivent être séparés par des espaces de deux lignes vides à partir de la description dans la docstring.

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) 

I a également fixé la faute de frappe pour type field1.