Dokumentation bauen und veröffentlichen¶
Bauen Sie in das normale Ausgabeverzeichnis des Projekts:
guidedog build html docs/manual -j auto -W
guidedog build pdf docs/manual -W
Die Website liegt in docs/manual/_build/html. PDF und erzeugter Typst-Quelltext liegen in docs/manual/_build/pdf. Ein Webserver kann das HTML-Verzeichnis statisch ausliefern. Ein Odin-Server ist im Betrieb nicht erforderlich.
Das Ausgabeverzeichnis wählen¶
Der Aufruf im Sphinx-Stil nennt Quelle und Ziel ausdrücklich:
guidedog build -b html docs/manual build/manual-site -W
Halten Sie Ausgaben außerhalb der Quellen. Guidedog verweigert einen Aufbau, bei dem die Veröffentlichung den Quellbaum ersetzen würde. Eigene Ziele nutzen einen stabilen benachbarten Cache wie build/.manual-site.guidedog/.doctrees. Im Ausgabeverzeichnis liegt daher nur die Veröffentlichung.
Vorschau und Prüfung¶
guidedog serve docs/manual
guidedog build dummy docs/manual -n -W
Der Dummy-Builder liest das Projekt und löst Referenzen auf, ohne eine Veröffentlichung zu erzeugen. Er eignet sich für eine schnelle semantische Prüfung, nicht für das endgültige Seitenlayout.
Ein reproduzierbarer Zeitpunkt¶
SOURCE_DATE_EPOCH=1790812800 guidedog build html docs/manual -W
Damit wird die Build-Zeit festgelegt. Reproduzierbarkeit hängt auch von Quellen, Vorlagen, Schriften, Compilerversionen und Ressourcen ab. Eine feste Uhrzeit allein genügt nicht.
Veröffentlichen Sie das vollständige Verzeichnis nach erfolgreichem Build. Ein erfolgreicher Prozessabschluss ist notwendig. Nach Vorlagenänderungen bleibt eine Sichtprüfung erforderlich.