name: Deploy MkDocs
on:
  push:
    branches:
      - main  # or master, depending on your default branch
  workflow_dispatch:

permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.x'
      - name: Install dependencies
        run: |
          pip install mkdocs-material
          pip install mkdocs-git-revision-date-localized-plugin
          pip install mkdocstrings[python]
      - name: Deploy
        run: mkdocs gh-deploy --force