Publishing

The docs are built with MkDocs and published to GitHub Pages with Mike. Mike keeps multiple versions on the gh-pages branch and writes the versions.json metadata that the superbiche theme uses for its version selector.

Setup

Install the local docs toolchain from the repository root:

scripts/docs deps

This installs MkDocs, Mike, and the local superbiche theme package.

Local Builds

Build the current docs:

scripts/docs build

Serve the current docs:

scripts/docs serve

Serve the versioned gh-pages output locally:

scripts/docs mike-serve

Publish

Publish a new release version and move the latest alias:

scripts/docs deploy-latest 0.1

Publish an additional named version without changing latest:

scripts/docs deploy dev

Set the root redirect:

scripts/docs set-default latest

List deployed versions:

scripts/docs list

GitHub Pages

Configure GitHub Pages to serve from the gh-pages branch. The published site URL is:

https://superbiche.github.io/safe/

The root URL redirects to the version selected with scripts/docs set-default.