Question

我有一个以下示例模型

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)

由 Sphinx 呈现，如下所示

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

鉴于所有参数都在单线凝固，这看起来非常糟糕。这是默认行为还是我做错了什么，我可以做些什么来改变不同格式的输出吗？

Answer 1

info field lists中的参数必须用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)

我还修正了type field1的拼写错误。

Sphinx输出，更改文档字符串输出格式

1 个答案: