Documentation in this repository
The edox-ops repository maintains two documentation systems:
| Layer | Tool | Folder |
|---|---|---|
| Product site & guides | Docusaurus | website/ |
| Python API reference | Sphinx | docs-api/ |
Published layout
When built for production, Sphinx HTML is copied into the Docusaurus output:
| URL | Source |
|---|---|
/ | Docusaurus homepage |
/docs/* | Docusaurus guides |
/blog/* | Docusaurus blog (not versioned with docs) |
/api-reference | Docusaurus page embedding Sphinx at /api/* |
/api/* | Sphinx HTML (static files) |
Build commands
pip install -e ".[docs]"
make docs-api # Sphinx only
make docs-dev-api-sync # copy API into website/static/api for npm start
make docs # full static site with /api embedded
Contributor guides publish under /docs/guides/. Build and
architecture notes for maintainers:
docs/documentation-build.md,
docs/documentation-architecture.md.
Versioned docs
Docusaurus supports versioned documentation for
product releases. Blog posts remain in website/blog/ and do not follow the same
versioning model. Sphinx API docs track current main/develop unless you add a
separate release workflow later.