Блог

Я пишу документацию для своей функции, используя синтаксис napoleon. Я хотел бы иметь абзац после моего списка параметров в документах. Документы в настоящее время выглядят следующим образом:

 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