Name	Name	Last commit message	Last commit date
parent directory ..
environments	environments
styles	styles
tutorials	tutorials
README.md	README.md
cli.md	cli.md
core.md	core.md
environment-builder.md	environment-builder.md
environments.md	environments.md
index.md	index.md
mkdocs.yml	mkdocs.yml
quickstart.md	quickstart.md

Name

Last commit message

Last commit date

OpenEnv docs workflow

Use this guide to preview and build the MkDocs site that lives under docs/.

1. Install dependencies

uv venv
source .venv/bin/activate
uv pip install mkdocs-material mkdocs-include-markdown-plugin "mkdocstrings[python]" pymdown-extensions

The packages mirror what the GitHub Pages workflow installs, so local builds match CI.

mkdocs serve --config-file docs/mkdocs.yml

The site is served at http://127.0.0.1:8000/ with automatic reloads whenever files in docs/ or docs/mkdocs.yml change.

mkdocs build --config-file docs/mkdocs.yml --clean --site-dir site

This regenerates the static HTML into site/, matching .github/workflows/docs.yml. Inspect the output locally.