python - 狮身人面像中的文本外部参数部分

Question

我正在使用拿破仑语法为我的函数编写文档。我想在文档中的参数列表之后有一个段落。文档当前如下所示：

def x(a):
    """
    A sample function.

    A sample blurb before.

    Parameters
    ==========
    a : str
        The input parameter

    A paragraph after.
    """
    return a

文档当前呈现（使用 RTD 主题）为

x(a)

一个示例函数。

之前的样本简介。

参数          * a ( str ) - 输入参数
                              * ( A )之后的段落-

我想看到的是

x(a)

一个示例函数。

之前的样本简介。

参数          * a ( str ) - 输入参数

后一段。

我如何告诉 sphinx/napoleon/rST 突破该Parameters部分？

Answer 1

看来我在该Parameters 部分中拥有的是一个定义列表。为了标记列表的结尾，需要两个空行以避免混淆，因为 reST 允许定义列表中的空行：

def x(a):
    """
    A sample function.

    A sample blurb before.

    Parameters
    ==========
    a : str
        The input parameter


    A paragraph after.
    """
    return a