Текст вне раздела параметров в сфинксе - PullRequest
0 голосов
/ 01 апреля 2019

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

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 ) - Входной параметр

A абзацпосле.

Как мне сказать sphinx / napoleon / rST выйти из секции Parameters?

1 Ответ

0 голосов
/ 01 апреля 2019

Похоже, что у меня в Parameters разделе есть список определений .Чтобы отметить конец списка, необходимо две пустые строки, чтобы избежать путаницы, поскольку reST допускает пустые строки в списке определений:

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

    A sample blurb before.

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


    A paragraph after.
    """
    return a
...