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

疯狂的物理学家

我正在使用拿破仑语法为我的函数编写文档。我想在文档中的参数列表之后有一个段落。文档目前看起来像这样:

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 节中拥有的是一个定义列表为了标记列表的结尾,需要两个空行以避免混淆,因为 reST 允许在定义列表中使用空行:

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

    A sample blurb before.

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


    A paragraph after.
    """
    return a

本文收集自互联网,转载请注明来源。

如有侵权,请联系[email protected] 删除。

编辑于
0

我来说两句

0条评论
登录后参与评论

相关文章

来自分类Dev

URL中的狮身人面像替换

来自分类Dev

在想狮身人面像部分重建索引?

来自分类Dev

如何链接到狮身人面像toctree中的页面部分

来自分类Dev

如何链接到狮身人面像toctree中的页面部分

来自分类Dev

在狮身人面像表单元格中设置文本格式

来自分类Dev

在狮身人面像中替换尖括号

来自分类Dev

在狮身人面像文档中打印变量值

来自分类Dev

将狮身人面像指向构建目录中的图像

来自分类Dev

如何在狮身人面像中添加html标签?

来自分类Dev

捕获狮身人面像画廊中的Graphviz图形

来自分类Dev

HAS中的狮身人面像状况的思考

来自分类Dev

狮身人面像rt索引中的unix时间戳

来自分类Dev

在狮身人面像文档中打印变量值

来自分类Dev

思维狮身人面像-多态关联中的搜索数据

来自分类Dev

将狮身人面像指向构建目录中的图像

来自分类Dev

在狮身人面像中近似“包含”的最佳方法?

来自分类Dev

在狮身人面像中放置条件以及如何在狮身人面像中删除setlimit

来自分类Dev

思维狮身人面像索引性能

来自分类Dev

狮身人面像搜索索引

来自分类Dev

laravel 5狮身人面像搜索

来自分类Dev

狮身人面像搜索索引

来自分类Dev

思维狮身人面像或状况

来自分类Dev

狮身人面像排序和分组

来自分类Dev

狮身人面像搜索和Laravel

来自分类Dev

思维与狮身人面像过滤与归属

来自分类Dev

laravel 5狮身人面像搜索

来自分类Dev

特定顺序的狮身人面像搜索

来自分类Dev

诗歌 + 狮身人面像 + Cython

来自分类Dev

带有狮身人面像关联的思维狮身人面像过滤