docs.yml

name: Deploy Documentation

on:
  push:
    branches:
      - main
      - master

permissions:
  contents: write

jobs:
  deploy:
    # Only run this job if the commit message contains [DOC]
    if: contains(github.event.head_commit.message, '[DOC]')
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - 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: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.x

      - name: Install MkDocs and Material Theme
        run: |
          pip install mkdocs-material

      - name: Deploy to GitHub Pages
        run: |
          mkdocs gh-deploy --force