Sphinx: Setzen eines Code-Segment in der ersten Zeile einer ungeordneten Liste Artikel

Question

Ich bin Sphinx mit meinem Projekt in der Dokumentation zu verwalten.

Ich habe eine ungeordnete Liste, und ich möchte, dass die erste Zeile jedes Element ein Code-Segment sein. (Nicht inline, ein Absatz.)

Wie kann ich das tun?

Answer 1

Ein Blick auf meiner eigenen Dokumentation fand ich ein ähnliches Szenario, aber ich kann nicht garantieren, dass es mit der Dokumentation als die erster Text in der Liste funktioniert:

#.  **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):
                ...

Dies erzeugt:

Ich denke, man kann ohne Pre-amble Text wie die folgenden mit einem Codeblock weg:

#.  ::
        def fooDeFaFa():
            pass

Beachten Sie, dass mein Code-Block zweimal eingerückt ist. Die :: zeigt den leeren Text Absatz Block, und dann mein Code ist ein Kind dieser :: Syntax über ein zweites Mal einrücken.

Alternativ kann dies funktionieren:

#.
    ::
        def fooDeFaFa():
            pass