狮身人面像中的文本外部参数部分答案

【问题标题】：Text outside parameters section in sphinx狮身人面像中的文本外部参数部分
【发布时间】：2019-04-01 18:50:08
【问题描述】：

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

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)

一个示例函数。

之前的示例简介。

Parameters * a(str) - 输入参数

后面的一段。

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

【问题讨论】：

标签： python python-sphinx restructuredtext sphinx-napoleon

【解决方案1】：

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

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

    A sample blurb before.

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


    A paragraph after.
    """
    return a

【讨论】：