Software-Dokumentation mit Sphinx

Damit euer Software-Paket sinnvoll genutzt werden kann, sind Dokumentationen erforderlich, die Beschreiben, wie eure Software installiert, betrieben, genutzt und verbessert werden kann. Für umfangreiche Dokumentationen könnt ihr Sphinx verwenden, ein Dokumentationswerkzeug, das reStructuredText in HTML oder PDF, EPub und man pages umwandelt.

Schulungsziel

Ihr werdet mit Sphinx euer Projekt dokumentieren können, wobei Code-Blöcke, Platzhalter, UI-Elemente und Interaktionen spezifisch ausgezeichnet sowie Inhaltsverzeichnisse und Glossare automatisch erstellt werden. Sphinx kann darüberhinaus Python Docstrings automatisch auslesen und daraus eine Referenzdokumentation erstellen. Schließlich lässt sich Sphinx auch noch sehr umfangreich erweitern, sodass keine Wünsche offenbleiben sollten.

Zielgruppe

Ihr arbeitet in einer technischen Redaktion oder entwickelt Software, die schnell und einfach dokumentiert werden soll.

Inhalt

  1. Tag
    • Sphinx-Projekt erstellen
    • reStructuredText
    • Docstrings
    • Intersphinx
    • Erweiterungen

Unser Angebot

In unseren In-house- und Online-Seminaren gehen wir genau auf euren Bedarf ein. Dabei stimmen wir vorher die Inhalte genau mit euch ab. Gerne erstellen wir euch hierfür ein individuelles Angebot.

Eure Vorteile:

Preis:

ab 960 € (zzgl. MwSt.)

Portrait Veit Schiele
Veit Schiele
Telefon: +49 30 22430082
E-Mail schreiben

Ich rufe euch auch gerne zurück!

Jetzt anfragen