Sphinx: Mettre un segment de code à la première ligne d'un élément de liste non ordonné

Question

J'utilise Sphinx pour gérer la documentation de mon projet.

J'ai une liste non ordonnée, et je veux que la première ligne de chaque élément soit un segment de code. (Pas en ligne, un paragraphe.)

Comment puis-je faire cela?

Answer 1

regardant ma propre documentation que je trouve un scénario similaire, mais je ne peux pas garantir que cela fonctionnera avec la documentation que le premier texte dans la liste:

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

Ce produit:

Je pense que vous pouvez vous en sortir avec un bloc de code sans texte pré-amble comme ce qui suit:

#. :: 
     def fooDeFaFa(): 
      pass 

Notez que mon bloc de code est indenté deux fois. Le :: indique le bloc de paragraphe textuel vide, puis mon code est un enfant de cette syntaxe :: en indentant une seconde fois.

Sinon, cela peut fonctionner:

#. 
    :: 
     def fooDeFaFa(): 
      pass