Erstellen Sie Ihr erstes Projekt¶
In diesem Tutorial erstellen Sie ein einfaches Dokumentationsprojekt mit Sphinx und sehen es im Browser als HTML an. Das Projekt wird erzählerische, handgeschriebene Dokumentation sowie automatisch generierte API-Dokumentation enthalten.
Das Tutorial richtet sich an Sphinx-Neulinge, die die Grundlagen der Erstellung und Strukturierung von Projekten erlernen möchten. Sie erstellen eine fiktive Softwarebibliothek zur Generierung zufälliger Essensrezepte, die als Leitfaden für den gesamten Prozess dient, mit dem Ziel, diese ordnungsgemäß zu dokumentieren.
Um die Fähigkeiten von Sphinx für die Code-Dokumentation zu demonstrieren, verwenden Sie Python, das auch die *automatische* Dokumentengenerierung unterstützt.
Hinweis
Mehrere andere Sprachen werden in Sphinx nativ für die *manuelle* Code-Dokumentation unterstützt, erfordern jedoch Erweiterungen für die *automatische* Code-Dokumentation, wie z.B. Breathe.
Um die Anweisungen befolgen zu können, benötigen Sie Zugriff auf eine Linux-ähnliche Kommandozeile und ein grundlegendes Verständnis ihrer Funktionsweise sowie eine funktionierende Python-Installation für die Entwicklung, da Sie *virtuelle Python-Umgebungen* zur Erstellung des Projekts verwenden werden.