deploy_docs.yaml

name: Deploy doc to GitHub Pages

on:
  release:
    types:
      - published
  workflow_dispatch:

env:
    python-version: "3.10"

jobs:
  deploy-doc:
    name: Deploy Documentation
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python ${{ env.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.python-version }}

      - name: Install poetry
        run: make download-poetry

      - name: Set up pip cache
        uses: actions/cache@v4.0.0
        with:
          path: ~/.cache/pypoetry/virtualenvs
          key: venv-${{ env.python-version }}-${{ hashFiles('pyproject.toml') }}-${{ hashFiles('poetry.lock') }}

      - name: Set Poetry Path
        run: |
          echo "$HOME/.poetry/bin" >> $GITHUB_PATH


      - name: Install requirements
        run: |
          poetry run pip install --upgrade pip
          poetry install --only docs

      - name: Deploying MkDocs documentation
        run: |
          poetry run mkdocs build
          poetry run mkdocs gh-deploy --force