Schulung Sphinx - der Python Dokumentationsgenerator
(S1292)Überblick
Beschreibung
Für jede Software-Entwicklung und jedes technische Produkt muss eine entsprechende Dokumentation in verschiedenen Ausgabeformaten (z. B. HTML und PDF) zur Produktion von Handbüchern oder der Bereitstellung einer Online-Hilfe erstellt werden. Eine gute Dokumentation gilt zunehmend als Qualitätsmerkmal für Software und entscheidet nicht selten über den Erfolg eines Projekts. Mit Sphinx lässt sich dies auf einfache und bequeme Weise bewerkstelligen. Sphinx wurde ursprünglich zur Dokumentation von Python-Programmen entwickelt, kann aber auch bei anderen Programmiersprachen, zur Dokumentation technischer Systeme oder ganz allgemein als Autorensystem eingesetzt werden.
| Termin | Freie Plätze | Tage | € zzgl. MwSt. | ||||
|---|---|---|---|---|---|---|---|
| 04.06.-05.06.2012 |
|
>3 | 2 | 1.060,00 *
|
Buchen | Reservieren | |
| 29.10.-30.10.2012 | >3 | 2 | 1.060,00 *
|
Buchen | Reservieren |
= Durchführung garantiert
- * = 10% Frühbucherrabatt
= Der dritte Mitarbeiter nimmt kostenlos teil
Details
Schulungs-Ziel
Sie sind nach dem Seminar in der Lage, Ihre technische Dokumentation mit Sphinx zu erledigen und Ihren Kunden, bzw. der Öffentlichkeit, in mehreren Ausgabeformaten zur Verfügung zu stellen. Sie können die Dokumentation als integralen Bestandteil Ihrer Software am gleichen Ort wie die Software selbst pflegen. Sie wissen, wie Sie das System Ihren Bedürfnissen anpassen können und wo Sie bei komplexen Fragestellungen und Problemen Hilfe finden können. Grundlegende Kenntnisse werden im html Seminar vermittelt.
Wer sollte teilnehmen
Entwickler, die eine gute Dokumentation als Qualitätsmerkmal für Software begreifen, und eine bequeme Möglichkeit suchen, eine hochwertige Dokumentation zu erstellen. Technische Redakteure, die ein plattformübergreifendes System zur Erstellung technischer Dokumentation suchen, das einfach zu bedienen ist und diverse, qualitativ hochwertige Ausgabeformate bereitstellt.
Inhalt
- Installation des Systems
- Einrichtung und Konfiguration eines Dokumentationsprojekts mit Hilfe von sphinx-quickstart
- Konfigurationsmöglichkeiten für die HTML- und PDF-Ausgabe
- Gliederung und Organisation der Dokumentation
- Erzeugung verschiedener Ausgabeformate (HTML, PDF, HTML-Help, QTHelp, EPUB)
- ReStructured-Text-Markup
- Sphinx-Markup
- HTML-Theming
- Templating
- Automatische Integration von Docstrings
- Testen von Codebeispielen mit Doctests
- Informationsquellen im Internet
Organisation
Teilnehmerzahl
min. 1, max. 8 Personen *** Der Kurs findet garantiert statt! ***
Schulungszeiten
2 Tage, 1. Tag 10:00-17:00, Folgetag 09:00-16:00
Ort der Schulung
GFU-Schulungszentrum Köln oder bei Ihnen als Inhouse-Schulung
Buchungsalternativen
Firmenschulungsanfrage
Inhouse-Schulung mit individuellen Inhalten zum Wunschtermin. Wahlweise in Ihrem Hause oder im GFU-Schulungszentrum.
Individualschulungsanfrage
Schulung für eine Einzelperson mit individuellen Inhalten zum Wunschtermin.
Enthaltene Leistungen
- Schulungsunterlagen
- Teilnahmezertifikat
- Frühstück und Mittagessen
- Getränke, Obst und Snacks
