Sphinx: Setzen eines Codesegments in die erste Zeile eines ungeordneten Listeneintrags

Question

Ich benutze Sphinx, um die Projektdokumentation zu verwalten.

Ich habe eine ungeordnete Liste, und ich möchte die erste Zeile jedes Elements ein Codesegment sein. (Nicht inline, ein Absatz.)

Wie kann ich das tun?

Answer 1

auf eigener Dokumentation der Suche fand ich ein ähnliches Szenario, aber ich kann nicht garantieren, dass es mit der Dokumentation als ersten Text in der Liste arbeiten:

#. **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 folgt mit einem Codeblock weg:

#. :: 
     def fooDeFaFa(): 
      pass 

Beachten Sie, dass mein Codeblock zweimal eingerückt ist. Die :: zeigt den leeren Textabsatzblock an, und dann ist mein Code ein Kind dieser :: Syntax durch Einrücken ein zweites Mal.

Alternativ kann diese Arbeit:

#. 
    :: 
     def fooDeFaFa(): 
      pass