Konfiguration

conf.py

Option

Standard

Bedeutung

deciwa_mode

"auto"

auto: deciwa serve nutzen, wenn es antwortet, sonst offline reviewen · offline: nie nach einem Server fragen (statische Seiten, Demos) · server: nie offline gehen

deciwa_offline_annotations

True

das Feedback aus .deciwa/ mit dem Build ausliefern, damit es auch offline sichtbar ist; für öffentliche Builds auf False setzen

deciwa_root

der Ordner über conf.py, der .deciwa/ enthält

wo .deciwa/ liegt, falls es nicht über den Docs liegt

Optionen lassen sich auch auf der Kommandozeile setzen, z. B. sphinx-build -D deciwa_mode=offline ….

.deciwa/config.toml

author = "daniel"                  # name on your feedback (or DECIWA_AUTHOR)

[sphinx]
docs = "docs"                      # source folder for deciwa serve
build = "docs/_build/html"         # where deciwa serve builds to

[review]
required = ["need"]                # what must be approved
paths = []                         # only these sources, e.g. ["docs/technical/*"]

required nimmt Elementarten (need, heading, paragraph, item, row, code, note, figure), all oder Selektor-Muster wie sphinx-needs:PROP_* – siehe was freigegeben werden muss. Die Arten lassen sich auch im Panel schalten; Muster und Pfade stehen hier.

Elemente, die die Erweiterung findet

Art

In der Seite

need

jedes Sphinx-Needs-Objekt, über seine ID

heading

ein Abschnitt, ausgewählt über seine Überschrift

paragraph, item, row, code, note

Absätze, Listenpunkte, Tabellenzeilen, Codeblöcke, Hinweisboxen

figure

Grafiken, Abbildungen und eingebettete HTML-Bilder wie SVG-Diagramme

Erzeugte Inhalte (Need-Tabellen, das Inhaltsverzeichnis) lassen sich nicht reviewen; reviewe stattdessen ihre Quelle.