我正在使用拿破仑语法为我的函数编写文档。我希望在文档中的参数列表之后有一个段落。文档目前看起来像这样:
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
部分?
看来我在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