[sage-hamburg] 9.10.: Lenz Grimmer: Projektdokumentation mit reStructuredText und Sphinx: Eine Einführung

[Dirk Wetter]

Moin Hamburg und Umland,

hier wie gewohnt der Reminder für diesen Donnerstag.

BG, Dirk


Am 09/30/2014 09:41 PM, schrieb Dirk Wetter:
> 
> Moin Hamburg,
> 
> der nächste Vortrag steht bald ins Haus. Freue mich auf Lokalkolorit
> und besonders auf Lenz, der mal wieder bei uns einen Vortrag hält.
> 
> --snip
> 
> Die Eckdaten:
> 
> Datum:        Donnerstag, den 9.10.2014
> Uhrzeit:      19h
> Vortragender: Lenz Grimmer
> Titel:        Projektdokumentation mit reStructuredText und Sphinx: Eine Einführung
> Ort:          Uni RZ in der Schlüterstrasse 70, Seminarraum 304 (3.OG)
> Bier danach:  TBD
> 
> 
> ===Abstract
> Es gibt viele Möglichkeiten der Projekt-Dokumentation, von Word-Dokumenten auf
> einem File-Server, Doku-Seiten auf einem Wiki bis hin zu komplexeren
> Dokumentationsystemen wie DocBook XML. Jede davon hat Ihre besonderen
> Eigenschaften und Vor- und Nachteile, z.B. im Hinblick auf die Erlern- und
> Benutzbarkeit, Teamfähigkeit, Revisionskontrolle, Automatisierung sowie der
> verfügbaren Ausgabeformate.
> 
> reStructuredText (reST) ist eine relativ einfach aufgebaute und schnell zu
> erlernende Text-Markup-Sprache, in der selbst der Dokumenten-Quelltext sehr gut
> les- und editierbar ist, ohne den eigentlichen Inhalt zu sehr mit Markup-Code
> zu verunstalten. Der Parser ist Bestandteil des Python-basierten "Docutils"
> Projekts und unterstützt diverse Ausgabeformate wie z.B. HTML, XML oder LaTeX.
> 
> Das auf reST basierende Dokumentationswerkzeug Sphinx erweitert dessen
> Fähigkeiten und bietet die Möglichkeit, damit auch komplexere und
> umfangreichere Dokumente komfortabel zu verwalten. Sphinx wird von einer großen
> Zahl von Open-Source-Projekten für die Dokumentation verwendet und wird selbst
> von einer sehr engagierten Community stetig weiter entwickelt.
> 
> Dieser Vortrag gibt einen Überblick und eine Einführung in reST und Sphinx und
> wie sich diese Kombination anhand der oben genannten Kriterien von den anderen
> Möglichkeiten unterscheidet.
> 
> Er richtet sich an Entwickler und Administratoren, die auf der Suche nach einer
> schlanken und flexiblen Lösung für die Erstellung und Pflege ihrer Dokumentation
> oder nach einer Alternative zu einer bestehenden Dokumentations-Lösung sind.
> Mögliche Migrations-Pfade dafür werden ebenfalls vorgestellt.
> 
> ===Bio
> Lenz Grimmer arbeitet bei der TeamDrive Systems GmbH als Product Manager
> für die LAMP-basierten TeamDrive Serverprodukte.
> 
> Er ist seit 1995 im Linux- und Open-Source-Umfeld aktiv und arbeitete u.a. als
> Entwickler, Community Relations Manager und Product Manager bei Firmen wie
> der SuSE Linux AG, MySQL AB, Sun Microsystems und Oracle.
> 
> --snap
> 
> 
> Um eine kurze Mail "Ja ich bin dabei" würde ich mich freuen, sie hilft bei der
> Planung. Formlose E-Mail bitte an hamburg at guug.de . Alle Treffen sind wie
> immer frei und offen.
> 
> Mehr zur GUUG-Lokalgruppe Hamburg, zur öffentlichen Mailing-Liste und
> mehr unter http://guug.de/lokal/hamburg/ . Falls Vortrag
> oder Treffen möglicherweise für Kollegen/Bekannte interessant sein
> könnte, leitet diese Mail gerne weiter. Auch sie sind herzlich
> willkommen.
> 
> 
> Bis dahin und schönes langes WoE,
> 
> Dirk