reStructuredText (reST)

reStructuredText (reST) ist eine Auszeichnungssprache (Markup) mit dem Ziel, in der reinen Textform besonders lesbar zu sein. Ursprünglich wurde reST vor allem zur Dokumentation der Programmiersprache Python eingesetzt.

Es ist Teil des Docutils-Projekts der Python Doc-SIG (Documentation Special Interest Group), welche Dokumentations-Tools ähnlich wie Javadoc für Jave entwickelt. Darüber hinaus hat sich Docutils aber zu einem recht universell einsetzbaren Textverarbeitungsbibliothek entwickelt, welche den Export in viele andere Formate (LaTeX, HTML, ePUB, ODT usw.) ermöglicht. Dies macht das System auch für andere Anwendungsbereiche sehr interessant.

Eng verwandt mit der Beschreibungssprache reST ist die Sphinx-Toolchain, welche die eigentliche Übersetzung von reST-Dateien ind die unterschiedlichen Ausgabeformate übernimmt.

Texte in *reST* sind im allgemeinen als Klartext **gut lesbar**. Dies ergibt sich aus:

- einer einfachen Sytax

- der Verwendung von Einrückungen, die

  - intuitiv und

  - übersichtlich

  sind, sowie

- übersichtlichen Konstrukten.

Eine Übersicht findet sich auch unter http://www.sphinx-doc.org/en/stable/rest.html .

Texte in reST sind im allgemeinen als Klartext gut lesbar. Dies ergibt sich aus:

  • einer einfachen Sytax

  • der Verwendung von Einrückungen, die

    • intuitiv und

    • übersichtlich

    sind, sowie

  • übersichtlichen Konstrukten.

Eine Übersicht findet sich auch unter http://www.sphinx-doc.org/en/stable/rest.html .