Über dieses Handbuch¶
Dieses Handbuch beschreibt das implementierte Werkzeug und seine bewusst gesetzten Grenzen. Das separate GDS-Projekt enthält Vorschläge, Entscheidungen und den Verlauf der Begutachtung. Eine bessere Gestaltung ändert den Status eines Vorschlags nicht.
Der Aufbau folgt der Arbeit mit dem Werkzeug: Tutorials zum Lernen, Themenkapitel zum Verstehen, Anleitungen für konkrete Aufgaben und Referenzseiten zum Nachschlagen. Die Kapitel zum Innenleben erklären Invarianten und Beweise.
Der Text verwendet kleine Beispiele, benennt Annahmen und formuliert Aussagen direkt. Erklärungen sollen sich überprüfen lassen. Die Gestaltung setzt auf zurückhaltende Farben, deutliche Überschriften, eine gut lesbare Serifenschrift und barrierearme Navigation. Wortlaut und Gestaltung eines bestimmten Autors werden nicht nachgeahmt.
Dieses Projekt wurde mit guidedog quickstart angelegt und wird mit Guidedog gebaut. Der Text steht in RST, die Diagramme in Graphviz und die Gleichungen in mathematischer LaTeX-Notation. Typst wird nur für die PDF-Satzvorlage verwendet.
Nachweise der Builds¶
Die Fernprüfung vom 2026-10-01 umfasste vollständige und inkrementelle HTML- und PDF-Builds für CPython, Django und Flask. Alle zwölf Befehle waren erfolgreich. Diagnosen und Linkprüfungen entsprachen dem bisherigen Referenzstand. 1.039 Linux-Tests und 94 gezielte Sanitizer-Tests bestanden. Das belegt das Verhalten des geprüften Stands, keine vollständige Sphinx-Kompatibilität. Die verbleibenden Grenzen stehen in Kompatibilität mit Sphinx.
Befehle zur Pflege der Dokumentation stehen in Diese Dokumentation pflegen.