LinuxUser

Gut angeleitet

Asciidoc(tor) und Sphinx im Praxistest

Nicht jedem liegt das Schreiben und Pflegen von technischen Dokumenten und Dokumentationen. Es erfordert Beharrlichkeit und Genauigkeit sowie ein Gespür für lesenswerten und verständlichen Text. Da sich zudem Software und die darin eingesetzten Verfahren recht häufig ändern, fällt es schwer, die begleitende Dokumentation synchron zu halten. Mit den beiden Werkzeugen Asciidoc und Sphinx vereinfachen Sie das Erstellen der Anleitungen, indem Sie im oder direkt neben dem Programmcode Dokumentation erstellen.

Asciidoc(tor) sowie Asciidoc FX waren schon des Öfteren Thema in LinuxUser. Jetzt gesellt sich Sphinx der Runde der Werkzeuge hinzu. Es wurde ursprünglich für die Dokumentation von Python entwickelt und kommt heute in fast

Sie lesen eine Vorschau, starten Sie ein Abonnement, um mehr zu lesen.

Mehr von LinuxUser

LinuxUser6 min gelesenProgramming
Neue Ordnung
Eine gute Notizsoftware sammelt nicht nur Notizen, sondern organisiert und vernetzt sie auch. Die App Hypernotes aus der Zenkit-Suite setzt dabei auf Markdown als Auszeichnungssprache und ermöglicht plattformübergreifenden Zugriff sowie das gemeinsam
LinuxUser4 min gelesen
Unverhofft Kommt Oft
Die Raspberry Pi Foundation hatte in den letzten zwei Jahren kein leichtes Leben, vor allem die Chip-Krise machte ihr schwer zu schaffen. Damit schwand zunehmend die Hoffnung, bald eine neue Version 5 des Minirechners zu sehen. Doch es kam anders, un
LinuxUser2 min gelesen
Vorschau auf 01/2024
Sicherheit gehört in der modernen IT zu den zentralen Themen und deckt ein breites Spektrum an Verfahren und Werkzeugen ab. Aber während Konzerne und Organisationen oft ganze Abteilungen mit entsprechenden Fachleuten beschäftigen, müssen sich private

Ähnlich