docs.yml

name: Publish docs via GitHub Pages
on:
  push:
    branches:
      - master

jobs:
  build:
    name: Deploy docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Install the latest version of uv
        uses: astral-sh/setup-uv@v3
        with:
          version: "latest"
          enable-cache: true  # no need, uses the local uv cache.
          # https://github.com/astral-sh/setup-uv?tab=readme-ov-file#github-authentication-token
          github-token: ${{ secrets.GITHUB_TOKEN }}
          cache-suffix: "3.10"

      - name: Pin python-version
        run: uv python pin 3.10

      - name: Install dependencies
        run: uv sync --extra docs --frozen

      - name: Deploy docs
        run: uv run mkdocs gh-deploy --force
        # note: Checking if we really need the one below:
        # uses: mhausenblas/mkdocs-deploy-gh-pages@1.9
        # # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
        # env:
        #   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}