diff --git a/README.md b/README.md index 75ff3e9..c46d74b 100644 --- a/README.md +++ b/README.md @@ -85,3 +85,19 @@ datatrail config init --site chime # Ensure valid CADC Certificate exists cadc-get-cert -u [username] ``` + +## Building the documentation + +From the repository root, install the locked documentation dependencies with +[uv](https://docs.astral.sh/uv/), then build the standalone public site: + +```shell +uv sync --locked --group docs +uv run --no-sync mkdocs build --strict --config-file mkdocs-site.yml +``` + +The site is written to `site/`. To preview it locally, run +`uv run --no-sync mkdocs serve --config-file mkdocs-site.yml`. +The installed checkout supplies the generated CLI reference. `mkdocs-site.yml` +adds the public site's theme and rendering extensions while inheriting the +navigation from `mkdocs.yml`, which remains the handbook configuration. diff --git a/docs/commands.md b/docs/commands.md index 35edcb4..9104b3d 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -27,4 +27,4 @@ The commands available to you are: - `version`: List the CLI and server version. Detailed information on all of the CLI commands can be found on the -[Reference](cli) page. +[Reference](cli.md) page. diff --git a/docs/index.md b/docs/index.md index e1f8d5e..018a52a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@ comments: true