RST und Sphinx

Unser Open Source Admin Handbuch, unser internes Wiki oder die neuen READMEs zu unseren Open Source Projekten haben eines gemeinsam: Sie werden von uns in der Auszeichnungssprache reStructuredText (kurz ReST, reST oder RST) in diversen Editoren wie Sublime, Vim oder Visual Studio Code geschrieben und gepflegt.

Wir sind darauf bereits in den Artikeln Blog: Wechsel von HTMLy zu Sphinx und ABlog und Das Open Source Admin-Handbuch der Linuxfabrik hier im Blog eingegangen. Aber wo fängt man an? Wo findet man Infos zu den verwendeten Standards und Tools? Anbei ein paar Links.

RST (Auszeichnungssprache)

• Quick Reference:
  https://docutils.sourceforge.io/docs/user/rst/quickref.html
• Komplette Spezifikation:
  https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html

Sphinx (Dokumentations-Generator)

• RST-Referenz plus Eigenheiten für Sphinx:
  https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
• Umgang mit Sphinx, Quick Start:
  https://www.sphinx-doc.org/en/master/usage/quickstart.html
• Doku zur conf.py:
  https://www.sphinx-doc.org/en/master/usage/configuration.html

ABlog (Blog-Erweiterung für Sphinx)

• Projekt-Seite:
  https://ablog.readthedocs.io/

Layouting

• Themes für Sphinx:
  https://sphinx-themes.org/

Spezielles

• RST Cheat Sheet:
  https://gist.github.com/ionelmc/e876b73e2001acd2140f
• Create Documentation with RST, Sphinx, Sublime, and GitHub:
  https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html
• RST Plugins für Visual Studio Code:
  https://marketplace.visualstudio.com/search?term=rst&target=VSCode