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

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 sample function.

A sample blurb before.

Parameters * a(str) - The input parameter
* paragraph after(A) -

我想看的是

x(a)

A sample function.

A sample blurb before.

Parameters * a(str) - The input parameter

A paragraph after.

如何告诉 sphinx/napoleon/rST 跳出 Parameters 部分？

Answer 1

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

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

    A sample blurb before.

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


    A paragraph after.
    """
    return a

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

Text outside parameters section in sphinx

python

restructuredtext

python-sphinx

sphinx-napoleon