Сфинкс: размещение сегмента кода в первой строке неупорядоченного элемента списка

Question

Я использую Sphinx для управления документацией моего проекта.

У меня есть неупорядоченный список, и я хочу, чтобы первая строка каждого элемента была сегментом кода. (Не в строке, абзац.)

Как я могу это сделать?

Answer 1

Глядя на свою собственную документацию, я нашел похожий сценарий, однако я не могу гарантировать, что он будет работать с документацией в виде текста first в списке:

#.  **Defining the Model Class**

    All models must inherit from |LrbBaseModel| either directly or
    indirectly and have the |LrbModelInit| decorator above their
    constructor (a.k.a. ``__init__``)::

        class foo(LrbBaseModel):
            @LrbModelInit()
            def __init__(self):
                ...

Это производит:

Я думаю, что вы можете обойтись без блока кода без предварительного текста, подобного следующему:

#.  ::
        def fooDeFaFa():
            pass

Обратите внимание, что мой блок кода имеет два отступа. :: указывает на пустой блок текстового абзаца, а затем мой код является потомком этого синтаксиса :: через отступ во второй раз.

В качестве альтернативы это может работать:

#.
    ::
        def fooDeFaFa():
            pass