Sphinx: Unexpected unindent

Sphinx ist das Standardtool zur Dokumentation von Python Code. Sphinx liest direkt DocStrings aus dem Quellcode aus und bereitet dabei eine Dokumentation auf.

Ideal wäre es wenn das natürlich ganz ohne Änderungen am Code oder der Dokumentation abläuft und man nicht noch mehr syntatktische Regeln beachten muss.

WARNING: Block quote ends without a blank line; unexpected unindent.

Diese Fehlermeldung sagt allerdings etwas anderes. Dies ist ein Warning das Sphinx beim Kommando „make html“ ausgespuckt hat.

Ursache dafür war dieser Docstring mit Einrückungen:


def dummyfunction():

'''Das ist ein langer Kommentar mit mehreren Punkten:

   - Punkt1 : Lorem ipsum
     dolor il

   - Punkt2: ....

'''

....

Dieser Beitrag wurde unter Allgemein veröffentlicht. Setze ein Lesezeichen auf den Permalink.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

This site uses Akismet to reduce spam. Learn how your comment data is processed.