website.yml

name: Publish website 
on:
  push:
    branches:
      - main
  workflow_dispatch:
permissions:
  contents: write
jobs:
  deploy:
    name: Publish docs website
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Install dependencies
        run: |
          sudo apt-get install -y libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev

      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
      
      - name: Setup Python 
        uses: actions/setup-python@v5
        with:
          python-version: 3.11

      - name: Set up cache 
        uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ hashfiles('docs/**') }}-${{ hashfiles('mkdocs.yml') }}
          path: docs
          restore-keys: |
            mkdocs-material-
      
      - name: Install dependencies
        run: |
          pip install -r requirements-docs.txt
      
      - name: Deploy GitHub Pages
        run: mkdocs gh-deploy --force