deploy-docs.yml

name: Deploy Documentation to GitHub Pages

on:
  # Trigger the workflow on pushes to the master branch
  push:
    branches:
      - master

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Allow GITHUB_TOKEN to create deployment
permissions:
  contents: write # Required to push to gh-pages branch

jobs:
  deploy:
    runs-on: ubuntu-latest # Use the latest Ubuntu runner

    steps:
      - name: Checkout code
        uses: actions/checkout@v4 # Checks out your repository code

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

      - name: Install dependencies
        run: |
          pip install mkdocs mkdocs-material # Add any other mkdocs plugins you use here!
          # Example: pip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python pymdown-extensions

      - name: Deploy documentation
        run: mkdocs gh-deploy --force --clean --remote-name origin --message "Deploy documentation from GitHub Actions"