docs.yml

name: Build and Deploy Docs

on:
  push:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout BasisSimulator.jl
        uses: actions/checkout@v4

      - name: Setup Julia
        uses: julia-actions/setup-julia@v2
        with:
          version: '1.12'

      - uses: julia-actions/cache@v2

      - name: Install dependencies
        run: |
          julia --project=docs -e '
            using Pkg
            Pkg.Registry.add("General")
            Pkg.resolve()
            Pkg.instantiate()
          '

      - name: Build docs
        # `BASISSIM_SKIP_NB_EXPORT` short-circuits the Pluto notebook
        # render in `docs/app.jl` — CI can't run our Metal/CUDA kernels
        # so we never attempt re-rendering on the runner.  Notebooks are
        # rendered locally (Apple Silicon Metal GPU), and the resulting
        # HTML is committed under `docs/notebooks-static/` and tracked
        # in the repo.  CI just mounts those HTML files into `dist/`.
        env:
          BASISSIM_SKIP_NB_EXPORT: "1"
        run: |
          julia --project=docs --optimize=3 docs/app.jl build

      - name: Setup Pages
        uses: actions/configure-pages@v4

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/dist

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