Official documentation hub for the RQM platform.
This site is built with MkDocs and Material for MkDocs.
Canonical docs URL: https://docs.rqmtechnologies.com/
rqm-docs documents the current platform layers reflected in this site:
rqm-core— mathematical spinerqm-circuits— canonical external circuit IR boundaryrqm-compiler— internal optimization enginerqm-api— service boundaryrqm-studio— workflow layer
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serveThe site is available at http://127.0.0.1:8000.
To build the static site:
mkdocs build --strictBuild output is written to site/.
This repository is a static MkDocs site and is deployed on Vercel using a project-local virtual environment.
Vercel's Python runtime may be externally managed (for example by uv), so direct system-level pip install can fail. Creating and using .venv keeps dependency installation isolated from the managed system Python and avoids externally-managed-environment errors.
- Framework preset:
Other("framework": nullinvercel.json) - Install command:
python -m venv .venv && . .venv/bin/activate && python -m pip install --upgrade pip && pip install -r requirements.txt - Build command:
. .venv/bin/activate && mkdocs build --strict - Output directory:
site/
The site/ directory is the published static output from MkDocs.
If a GitHub Actions workflow exists in this repo, treat it as optional legacy automation. The primary publishing posture for this repo is Vercel static deployment.