Пример строки документа в стиле Google не отображается как фрагмент кода

Question

Недавно я начал добавлять документацию в свой проект, и я пытаюсь следовать руководству по стилю Google. Я использую Sphinx для генерации документов и расширение Sphinx для преодоления разрыва между Google style guide и reST.

У меня нет проблем с рендерингом параметров и заметок, но я не могу получить раздел "Пример" для рендеринга фрагмента кода.

class Chicken(object):
      """Animal that lays egg and has feathers

         Note:
             Chickens love to eat feed

         Example:
             chicken.eats(feed)
      """

Я также попробовал двойное двоеточие с разделом Пример.

Example::

Answer 1

Вам нужно двойное двоеточие И пустая строка между Example:: разрыв раздела и буквальный блок.

Смотрите пример из документов Наполеона:

"""Example Google style docstrings.

This module demonstrates documentation as specified by the `Google Python
Style Guide`_. Docstrings may extend over multiple lines. Sections are created
with a section header and a colon followed by a block of indented text.

Example:
    Examples can be given using either the ``Example`` or ``Examples``
    sections. Sections support any reStructuredText formatting, including
    literal blocks::

        $ python example_google.py

Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.
"""

Итак, в вашем примере попробуйте это:

class Chicken(object):
      """Animal that lays egg and has feathers

         Note:
             Chickens love to eat feed

         Example::

             chicken.eats(feed)
      """

Answer 2

Основываясь на ответе @Brown, он появляется для того, чтобы раздел "Пример" отображался как распознанный разрыв раздела, так и как фрагмент кода, вы должны использовать "Пример:", за которым следует "::" с отступом, за которым следует пустая строка. и фрагмент кода с двойным отступом. Для меня оба нижеследующих представляют блок кода, начинающийся с выделенного жирным шрифтом "Пример" на выходе.

class Chicken(object):
      """Animal that lays egg and has feathers

         Note:
             Chickens love to eat feed

         Example:
             Detail about example (I'm feeding the chicken)::

                 chicken.eats(feed)
      """

ИЛИ:

class Chicken(object):
      """Animal that lays egg and has feathers

         Note:
             Chickens love to eat feed

         Example:
             ::

                 chicken.eats(feed)
      """