Skip to main content

Documentation in this repository

The edox-ops repository maintains two documentation systems:

LayerToolFolder
Product site & guidesDocusauruswebsite/
Python API referenceSphinxdocs-api/

Published layout

When built for production, Sphinx HTML is copied into the Docusaurus output:

URLSource
/Docusaurus homepage
/docs/*Docusaurus guides
/blog/*Docusaurus blog (not versioned with docs)
/api-referenceDocusaurus 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.