name: Documentation
on:
  push:
    branches:
      - main

permissions: {}

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-24.04
    name: Build docs
    permissions:
      contents: read
      pages: write # needed to build GitHub Pages artifacts
      id-token: write # needed for OIDC authentication with GitHub Pages
    steps:
      - uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false
      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
        with:
          python-version: 3.x

      - run: pip install -r docs/requirements.txt
      - run: python3 -m mkdocs build --config-file ./mkdocs.yaml --site-dir site/
        id: build

      - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
        id: deployment
        with:
          path: site/
          name: github-pages

  deploy:
    needs: build
    runs-on: ubuntu-24.04
    name: Deploy docs
    permissions:
      pages: write # needed to deploy to GitHub Pages
      id-token: write # needed for OIDC authentication with GitHub Pages
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5
        id: deployment
        with:
          artifact_name: github-pages