Die Sphinx beißt nicht, reStructuredText für Literaten

Ich stecke immer noch in meinem Projekt »reStructuredText und Sphinx für Literaten« (reST and Sphinx for Poets), da sich heute bei meinem Klienten gezeigt hat, daß eine Einführung in reStructuredText dringend gebraucht wird.

Zwar bin ich – auch Dank des wunderbaren Buches von juh – schon ein gutes Stück vorangekommen und habe auch selber schon ein erstes Projekt vollständig in reStructuredText geschrieben und mit Sphinx nach HTML und LaTeX/PDF herausgerendert, aber für Anregungen bin ich natürlich immer dankbar.

Und diese Anregungen fand ich heute in einem Vortrag von Damian Skrzypczak mit dem Titel »Sphinx won’t bite you! Documenting Python code«, den dieser schon 2018 gehalten hat. Nicht nur, daß es 35 recht vergnügliche Minuten sind, sondern hier findet man auch die Folien seines Vortrags, darunter eine kompakte Einführung in reStructuredText, die wie geschaffen ist für (m)ein »reStructuredText für Literaten«.

In seinen Folien verweist Damian Skrzypczak immer wieder auf den Blogbeitrag »What nobody tells you about documentation« von Daniele Procida, ebenfalls sehr lehrreich und dennoch vergüglich. Daher habe ich das Video dazu auch noch in diesem Blog Kritzelheft-Beitrag untergebracht.

(Kommentieren)