ReStructuredText – einfach erklärt

Zweck und Einsatz

reStructuredText (kurz ReST, reST oder RST) ist eine vereinfachte Auszeichnungssprache. Sie soll als reiner Text besonders gut lesbar sein und sich leicht in andere Formate umwandeln lassen. Die Dateiendung lautet .rst, der MIME-Type text/x-rst. Entwickelt wurde sie von David Goodger; die Erstveröffentlichung war am 2. April 2002.

Der reStructuredText-Parser gehört zu Docutils, einer in Python entwickelten Textverarbeitungsbibliothek. Docutils-Version 0.6 unterstützt Umwandlungen in ODT, Manpage, S5, XHTML, XML und LaTeX. Über LaTeX sind professioneller Schriftsatz sowie Exporte nach PostScript und PDF möglich.

ReStructuredText wird verbreitet für Docstrings verwendet, also Python-typische Kommentare zur Programmdokumentation. Auch das Dokumentationswerkzeug Sphinx nutzt es. Einige Wiki-Systeme bieten es zusätzlich zu ihrer eigenen Wiki-Syntax an. GitHub, Bitbucket und GitLab unterstützen reST. Vergleichbare leichte Auszeichnungssprachen sind Markdown, Textile und AsciiDoc.

Wichtige Syntaxformen

Überschriften werden durch eine Zeile aus Zeichen unter dem Titel markiert: Gleichheitszeichen stehen im Beispiel für einen Abschnitt, Bindestriche für einen Unterabschnitt.

Aufzählungslisten verwenden Bindestriche vor den Punkten. Nummerierte Listen können mit „1)“, „2)“ und „3)“ geschrieben werden; Unterebenen sind beispielsweise mit „a)“ und danach „i)“ möglich.

Benannte Hyperlinks bestehen aus einem verlinkten Text mit nachgestelltem Unterstrich und einer Zieldefinition, etwa „.. Demonstration: https://de.wikipedia.org/wiki/Demonstration“. Anonyme Hyperlinks verwenden im Text zwei Unterstriche; das Ziel wird anschließend mit „_ https://www.python.org/“ angegeben.

Fußnoten können im Text mit „[#]_“ markiert und später mit „.. [#]“ erläutert werden. Sie können automatisch durchnummeriert werden.