halcyon-docs

Source for the Halcyon documentation.

Live site: https://halcyon-project.github.io/halcyon-docs

The docs are built with Sphinx (Markdown via the MyST parser) and published to GitHub Pages automatically by the Deploy docs to GitHub Pages workflow on every push to master.

Building locally

python -m venv .venv
source .venv/bin/activate        # Windows: .venv\Scripts\activate
pip install -r requirements.txt
sphinx-build -b html . build

Then open build/index.html in a browser.