docs.yml

name: Deploy Documentation

on:
  push:
    branches:
      - main # Deploy on pushes to the main branch

# Permissions for GitHub Pages deployment
permissions:
  contents: write  # Required for gh-deploy to push to gh-pages branch
  pages: write     # Required for GitHub Pages deployment
  id-token: write  # Required for GitHub Pages deployment

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.10'

      - name: Install documentation dependencies
        run: pip install mkdocs mkdocs-material # Assuming MkDocs

      - name: Deploy docs
        run: mkdocs gh-deploy --force