Документы Sphinx и реструктурированный текст: замена при определении параметра в нескольких строкахPython

Программы на Python
Ответить Пред. темаСлед. тема
Anonymous
 Документы Sphinx и реструктурированный текст: замена при определении параметра в нескольких строках

Сообщение Anonymous »

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

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

"""
verbosity: int, optional
Sets how much feedback the code will provide in the console output:

• *0: Silent mode.* The code won’t provide any feedback, apart from error messages.
• *1: Normal mode* (default). The code will provide essential feedback such as progression markers and
current steps.
• *2: Chatty mode.* The code will provide all possible information on the events happening. Note that this
may clutter the output and slow down the execution.
"""
Поскольку этот параметр появляется здесь и там, я хотел бы заменить базовое копирование/вставку подстановкой. Я увидел, что это возможно, установив параметр rst_prolog в файле conf.py, например:

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

rst_prolog = """
.. |verbosity| replace:: description
"""
Однако кажется, что такое определение замены позволяет «описанию» содержать только один абзац. Есть идеи, как сохранить текст с уже имеющимися пунктами?
Спасибо!

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

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

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

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

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

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

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