Skip to content

Regenerating the docs

The documentation build is deterministic from data/odoo-runtime-doc.json plus the curated source pages in this repository.

Refresh workflow

  1. Export the configured database using the repository exporter:
op run --env-file="path\to\.env.op" -- node scripts\export_runtime.mjs
  1. Review model/field count changes, the exporting identity/company, ACL changes, and required capability models.
  2. Run the generator:
& $python scripts/generate_docs.py
  1. Review generated metadata, curated contracts, model-count changes, and important field changes.
  2. Build strictly:
& $python -m mkdocs build --strict
  1. Commit the exporter, snapshot, generated reference pages, collections, and reviewed curated changes together.

The exporter requires ODOO_URL, ODOO_DB, ODOO_USERNAME, and ODOO_API_KEY (or ODOO_PASSWORD). Keep those values outside the repository. It uses legacy JSON-RPC only for metadata extraction because the existing secret workflow is already configured; generated integration examples target Odoo 19 JSON-2.

When to refresh

  • Before starting a new integration
  • After an Odoo upgrade
  • After installing or removing modules
  • After Studio model or field changes
  • After material access-group changes
  • Before publishing a new documentation version

Generated files

Do not manually edit files under docs/reference/models/, generated method and domain indexes, the snapshot-status page, download exports, or collections/. Change scripts/generate_docs.py or the snapshot, then regenerate.