Software-Dokumentation mit Sphinx¶
Damit euer Softwarepaket nützlich ist, ist eine Dokumentation erforderlich, die beschreibt, wie eure Software installiert, betrieben, verwendet und verbessert werden kann. Für eine umfangreiche Dokumentation könnt ihr Sphinx verwenden, ein Dokumentationswerkzeug, das reStructuredText in HTML oder PDF, EPub und man pages umwandelt.
Ziel der Schulung¶
Ihr werdet in der Lage sein, euer Projekt mit Sphinx zu dokumentieren, wobei Codeblöcke, Platzhalter, UI-Elemente und Interaktionen gezielt gekennzeichnet und Inhaltsverzeichnisse und Glossare automatisch erstellt werden. Sphinx kann auch automatisch Python-Docstrings lesen und daraus eine Referenzdokumentation erstellen. Schließlich ist Sphinx auch umfangreich erweiterbar, so dass keine Wünsche offen bleiben sollten.
Zielgruppe¶
Ihr arbeitet in einer technischen Redaktion oder entwickelt Software, die schnell und einfach dokumentiert werden muss.
Inhalt des Kurses¶
Tag 1
Sphinx-Projekt erstellen
reStructuredText
Docstrings
Intersphinx
Erweiterungen
Was wir anbieten¶
In unseren Inhouse- und Online-Seminaren stimmen wir die Inhalte genau auf eure Bedürfnisse ab. Die Inhalte stimmen wir im Vorfeld mit euch ab. Gerne unterbreiten wir euch ein maßgeschneidertes Angebot.
Eure Vorteile:
📈 Aufeinander abgestimmte Inhalte:
💁 Persönliche Vorbesprechung
🤝 Maßgeschneiderte Inhalte
📖 Schulungsunterlagen
📃 Zertifikat
🧑💻 Trainer*innen aus der Praxis
🫴 Mentoring und 1:1-Coaching
Preise:
ab 960 € (zzgl. MwSt.)
Kontaktiert uns¶
Habt ihr eine Frage, die hier nicht beantwortet wird? Veit beantwortet gerne eure Fragen und erstellt euch ein maßgeschneidertes Angebot für euer Training.
