Installation

Die Sphinx-Integration ist das Paket deciwa-sphinx; es bringt die Review-Oberfläche (deciwa-ui) mit. Der Befehl deciwa kommt aus deciwa-cli. Bis die Pakete veröffentlicht sind, installierst du sie aus dem Repository.

Voraussetzungen

• Python 3.12 oder neuer

• Sphinx 9; Sphinx-Needs und MyST sind optional, werden aber erkannt

Installieren

$ cd <deciwa>/packages
$ uv pip install -e core -e server -e cli -e ui -e sphinx   # from your project's environment
$ deciwa init                      # creates .deciwa/ in the repository root

Die Erweiterung hinzufügen

In conf.py:

extensions = [
    "myst_parser",       # if you write Markdown
    "sphinx_needs",      # if you use Sphinx-Needs
    "deciwa.sphinx",
]

Die Erweiterung findet .deciwa/, indem sie vom Ordner von conf.py aus nach oben sucht. Liegt es woanders, setz deciwa_root – siehe Konfiguration.

Prüfen

$ deciwa serve
deciwa: building docs …
deciwa: build 1 ok
deciwa: review at http://127.0.0.1:4337/

Öffne die Adresse; das runde deciwa-Logo unten rechts heißt, das Overlay ist da.