Sphinx

Reviewe deine Sphinx-Docs dort, wo sie gelesen werden: auf den gebauten HTML-Seiten. Die deciwa-Erweiterung für Sphinx fügt jeder Seite das Review-Overlay hinzu und kennt die Elemente jeder Seite – Abschnitte, Absätze, Listenpunkte, Tabellenzeilen, Codeblöcke, Hinweise, Bilder und jedes Sphinx-Needs-Objekt über seine ID.

Sphinx-Integration: Quellen werden zu Seiten mit Overlay gebaut; deciwa serve speichert Feedback in .deciwa; die KI arbeitet die offenen Aufgaben ab und ändert die Quellen Quellen.md · .rst · needs sphinx-build+ deciwa-Erweiterung HTML-Seitenmit Review-Overlay dureview .deciwa/Feedback, in Git KI oder Entwicklungdeciwa todo · resolve deciwa serve
Bauen, reviewen, arbeiten, neu bauen – deciwa serve hält den Kreislauf am Laufen.

Zwei Arten, es zu betreiben

Mit deciwa serve

Offline

Wer

das Team, das an den Docs arbeitet

alle mit den gebauten Seiten – auch eine öffentliche Demo

Feedback wird gespeichert

in .deciwa/ des Repositorys

im Browser, exportiert als eine Datei

Neu bauen bei Änderungen

automatisch, die Seite lädt neu

dein eigener Build

KI und CLI sehen Feedback

sofort

nach deciwa import
Die Sphinx-Docs von deciwa mit dem Review-Overlay

Diese Docs mit dem Review-Overlay.

Seiten

  • Installation – die Erweiterung und die CLI

  • Konfiguration – Optionen in conf.py und .deciwa/config.toml

  • Workflow – ausliefern, reviewen, arbeiten, neu bauen; Offline-Review und Export