0

ナポレオン構文を使用して関数のドキュメントを書いています。ドキュメントのパラメーター リストの後に段落を追加したいと思います。現在、ドキュメントは次のようになっています。

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セクションから抜け出すように指示するにはどうすればよいですか?

4

1 に答える 1

0

このParameters セクションにあるのは定義リストのようです。リストの終わりを示すには、混乱を避けるために 2 つの空白行が必要です。これは、reST が定義リストで空白行を許可しているためです。

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

    A sample blurb before.

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


    A paragraph after.
    """
    return a
于 2019-04-01T19:30:26.357 に答える