Встроенные примеры autodoc в первый - PullRequest
Новая
       42

Встроенные примеры autodoc в первый

0 голосов
/ 22 октября 2019

Я использую Sphinx и autodoc для документирования кода. Я считаю полезным иметь в документации примеры типа .. code-block::. Тем не менее, я также помещаю эти примеры в строки документации в самом коде Python.

Например: 

def blerg():
  """something here

  Examples:
      .. code-block:: python3
            example
  """

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

Я ищу что-то, что позволило бы мне не дублировать примеры, но и не заставлять пользователя переходить к документации API.

...