Deployment¶

This project is preconfigured for static documentation publishing via MkDocs.

Local build¶

mkdocs build --clean

Output directory: site/

mkdocs serve

Preview URL: http://127.0.0.1:8000

From repository root:

mkdocs gh-deploy --clean

This command builds docs and publishes to the gh-pages branch.

Any static host can deploy the generated site/ directory:

Use CI to prevent broken docs:

mkdocs build --strict --clean

This fails the pipeline if navigation references missing pages or Markdown issues become blocking.