Comment faire pour supprimer la cause d'un avertissement d'indentation inattendue lors de la génération de la documentation de code?

Question

Le code de documentation du problème est au début d'une méthode:

""" 
Gtk.EventBox::button-release-event signal handler. 
:param widget: The clicked widget (The Gtk.EventBox). 
:param event: Gdk.EventButton object with information regarding 
     the event. 
:param user_data: The Gtk.LinkButton that should be opened when 
     the Gtk.EventBox is clicked. 
:return: None 
""" 

Les mises en garde sont les suivants:

C:/msys64/home/hope/python+gtk/test/main.py:docstring of main.Builder.advertisem 
ent_clicked:4: WARNING: Unexpected indentation. 
C:/msys64/home/hope/python+gtk/test/main.py:docstring of main.Builder.advertisem 
ent_clicked:5: WARNING: Block quote ends without a blank line; unexpected uninde 
nt. 

Que peut-on faire pour supprimer ces avertissements et leur cause (s)?

Answer 1

Il suffit d'ajouter une ligne vide après la description sommaire de la méthode, avant la description des paramètres:

""" 
Gtk.EventBox::button-release-event signal handler. 

:param widget: The clicked widget (The Gtk.EventBox). 
:param event: Gdk.EventButton object with information regarding 
     the event. 
:param user_data: The Gtk.LinkButton that should be opened when 
     the Gtk.EventBox is clicked. 
:return: None 
""" 

Here vous pouvez trouver ce conseil:

Si vous obtenez un Sphinx construire erreur qui indique «indentation inattendue», il est probablement parce que Sphinx attend une ligne vide, comme après un bloc de texte littéral . Votre ligne peut avoir enveloppé et confondu Sphinx. Dans ce cas, essayez de faire remonter le texte à la ligne précédente même si dépasse la marge de votre fenêtre. Ou, vous pouvez appuyer sur Entrez pour aller à la ligne suivante, mais assurez-vous de mettre en retrait le texte sur la nouvelle ligne.