deploy-docs.yml

name: Deploy Documentation

# Builds the MkDocs Material site (source: `site_docs/`) with
# `make docs-build` (which runs `mkdocs build --strict`) and
# publishes the generated `site/` to GitHub Pages.
#
# The previous hand-rolled HTML site at `website/` is preserved
# in the repo as the rollback source and historical reference,
# but is no longer deployed. Live URLs from the old site are
# preserved by the `mkdocs-redirects` plugin (see mkdocs.yml).

on:
  push:
    branches:
      - master
    paths:
      - 'site_docs/**'
      - 'mkdocs.yml'
      - 'requirements-docs.txt'
      - 'Makefile'
      - '.github/workflows/deploy-docs.yml'

  workflow_dispatch:

permissions:
  contents: read

jobs:
  build:
    name: Build MkDocs site
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 1

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
          cache: pip
          cache-dependency-path: requirements-docs.txt

      - name: Install docs dependencies
        run: pip install -r requirements-docs.txt

      - name: Install GenAIRR from PyPI (mkdocstrings needs to import it)
        # The reference pages use `:::` mkdocstrings directives to render
        # signatures + docstrings from real classes (Experiment,
        # SimulationResult, ReferenceCartridgeBuilder, etc.). For those
        # to resolve, GenAIRR must be importable in the build environment.
        # Installing from PyPI is fast (precompiled wheels) and means the
        # rendered API reference matches the latest released version,
        # which is what published docs should reflect.
        run: pip install GenAIRR

      - name: Build site with mkdocs build --strict
        run: make docs-build
        env:
          DISABLE_MKDOCS_2_WARNING: 'true'

      - name: Configure Pages
        uses: actions/configure-pages@v5

      - name: Upload Build Artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: site

  deploy:
    name: Deploy to GitHub Pages
    needs: build
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4