docs.yml

name: website

# build the documentation whenever there are new commits on main
on:
  push:
    branches:
      - main

# security: restrict permissions for CI jobs.
permissions:
  contents: read

jobs:
  # Build the documentation and upload the static HTML files as an artifact.
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install uv
        uses: astral-sh/setup-uv@v6
        with:
          python-version: '3.10.11'

      - name: Install dependencies
        run: |
          uv sync

      # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
      # It is assumed that the notebooks are converted to markdown files with `make notebooks`.
      - name: Build Docs
        run: |
          uv run mkdocs build

      - uses: actions/upload-pages-artifact@v3
        with:
          path: site/

  # Deploy the artifact to GitHub pages.
  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
  deploy:
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4