Sphinx

Review your Sphinx docs where readers read them: on the built HTML pages. The deciwa Sphinx extension adds the review overlay to every page and knows the elements of each page – sections, paragraphs, list items, table rows, code blocks, notes, pictures and every Sphinx-Needs object by its id.

Sphinx integration: sources are built into pages with the overlay; deciwa serve stores feedback in .deciwa; the AI works on the open jobs and changes the sources sources.md · .rst · needs sphinx-build+ deciwa extension HTML pageswith review overlay youreview .deciwa/feedback, in Git AI or developerdeciwa todo · resolve deciwa serve
Build, review, work, rebuild – deciwa serve keeps the loop running.

Two ways to run it

With deciwa serve

Offline

Who

the team working on the docs

anyone with the built pages – also a public demo

Feedback is stored

in .deciwa/ of the repository

in the browser, exported as one file

Rebuild on change

automatic, the page reloads

your own build

AI and CLI see feedback

at once

after deciwa import

Pages

  • Installation – the extension and the CLI

  • Configuration – conf.py options and .deciwa/config.toml

  • Workflow – serve, review, work, rebuild; offline review and export