Zum Inhalt

Dokumentation

Falls die Dokumentation geändert werden soll, so muss dafür mkdocs installiert sein (Das sollte ohnehin der Fall sein, wenn die Gruppe dev über poetry installiert wurde. Danach in der Kommandozeile im Repo einfach Folgendes eingeben:

mkdocs serve

Das sollte die Dokumentation erstellen und sie unter localhost:8000 bereitstellen. Normalerweise öffnet sich der Browser mit der Seite automatisch. Sollte das nicht der Fall sein, einfach http://127.0.0.1:8000 ansteuern. Die Seite hat einen automatischen Reload, Änderungen in den .md-Dateien sollten also sofort sichtbar sein.