docs.yml

name: Publish documentation

on:
  push:
    branches:
      - master
    paths:
      - .github/workflows/docs.yml
      - docs/**
      - mkdocs.yml

permissions:
  id-token: write
  pages: write

jobs:
  github-pages:
    name: Publish to GitHub Pages
    runs-on: ubuntu-latest

    environment:
      name: github-pages

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Python runtime
        uses: actions/setup-python@v5
        with:
          python-version: 3.x

      - name: Install dependencies
        run: pip install mkdocs-material

      - name: Build web pages
        run: mkdocs build --site-dir=docs-site

      - name: Upload to GitHub Pages
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs-site

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