docs.yaml

---
name: Documentation

on:
  push:
  pull_request:
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  ARTIFACT: docs

jobs:
  build-docs:
    name: Build docs
    runs-on: ["ubuntu-latest"]
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.10"

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          virtualenvs-create: true
          virtualenvs-in-project: true
          virtualenvs-path: .venv

      - name: Set up cache
        uses: actions/cache@v4
        id: cached-poetry-dependencies
        with:
          path: .venv
          key: venv-Linux-3.10-${{ hashFiles('poetry.lock') }}
          restore-keys: venv-Linux-3.10-

      - name: Install dependencies
        # if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --all-extras

      - name: Build dependencies
        run: poetry build

      - name: Build MkDocs docs
        env:
          JUPYTER_PLATFORM_DIRS: 1
        run: poetry run mkdocs build -f ./docs/mkdocs.yml -d ./_build/

      - name: Upload build artifacts
        uses: actions/upload-artifact@v4
        with:
          name: ${{ env.ARTIFACT }}
          path: ./docs/_build/
        if: ${{ always() }}

  deploy-docs:
    name: Deploy docs
    needs: build-docs
    permissions:
      pages: write
      id-token: write
    runs-on: ["ubuntu-latest"]
    if: github.ref == 'refs/heads/main'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Download Artifacts
        uses: actions/download-artifact@v4
        with:
          path: artifacts

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: artifacts/${{ env.ARTIFACT }}/

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4