docs.yml

name: Build Docs

on:
  push:
    branches: [ main ]
  release:
    types: [created, edited]
  pull_request:
    branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Checkout Repo
        run: |
          git config user.name github-actions
          git config user.email github-actions@github.com
          git fetch origin gh-pages --depth=1

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.11"

      - name: Set up Quarto
        uses: quarto-dev/quarto-actions/setup@v2

      - name: Install Dependencies
        run: |
          pip install uv
          uv pip install ".[docs]" --system

      - name: Build Docs
        if: github.event_name != 'pull_request'
        run: mike deploy ${{ github.ref_name }}

      - name: Test Build Docs
        if: github.event_name == 'pull_request'
        run: mike deploy pr_test

      - name: Tag with latest
        if: github.event_name == 'release' && github.event.action == 'created'
        run: mike alias -u ${{ github.ref_name }} latest

      - name: Push deployment
        if: github.event_name != 'pull_request'
        run: git push origin gh-pages