我正在使用拿破仑语法编写函数的文档。我想在文档中的参数列表后面有一个段落。该文档当前如下所示:
def x(a):
"""
A sample function.
A sample blurb before.
Parameters
==========
a : str
The input parameter
A paragraph after.
"""
return a
当前将文档呈现为(使用RTD主题)
x
(
a
)
一个示例函数。
之前有一个样本Blub。
参数 * * a ( str )-输入参数
* 后段( A )-
我想看的是
x
(
a
)
一个示例函数。
之前有一个样本Blub。
参数 * * a ( str )-输入参数
后面的一段。
如何告诉狮身人面像/拿破仑/ rST脱离Parameters
部分?
答案 0 :(得分:0)
看来我在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