Документация Sphinx, показывающая двойное двоеточие в поляхPython

Программы на Python
Ответить Пред. темаСлед. тема
Anonymous
 Документация Sphinx, показывающая двойное двоеточие в полях

Сообщение Anonymous »

Я разрабатываю документацию для пакета, и при сборке документации sphinx я получаю двойные двоеточия
[img]https://i .sstatic.net/8EmeK.png[/img]

для всех полей каждого определения функции.
Я использую стиль numpydoc для мои строки документации и нет двоеточия в этих документах указывают, откуда они могут быть взяты:

Код: Выделить всё

    """

Function description

Parameters
-----------
param1: str or list
A description for the parameter

Returns
-----------
Dictionary
Some info about what is returned

Examples
-----------
>>> output = somefunction(param1)

"""
Кто-нибудь сталкивался с этим раньше? Стоит отметить, что с полем «Примеры» этого не происходит. Только параметры, возвращаемые значения и тип возвращаемого значения.

Подробнее здесь: https://stackoverflow.com/questions/704 ... -in-fields
Реклама
Ответить Пред. темаСлед. тема

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

  • Похожие темы
    Ответы
    Просмотры
    Последнее сообщение

Вернуться в «Python»