.github/workflows/deploy-docs.yml

name: Deploy Documentation

on:
    release:
        types: [published]
        branches: [main]
    repository_dispatch:
        types: [package-release]

jobs:
    deploy-docs:
        runs-on: ubuntu-latest

        steps:
            - name: Check out
              uses: actions/checkout@v4

            - name: Set up the environment
              uses: ./.github/actions/setup-poetry-env

            - name: Deploy documentation
              run: poetry run mkdocs gh-deploy --force