documentation.yml

name: Documentation

on:
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
  # schedule:
  #   - cron: "0 0 * * *"
  push:
    branches:
      - main

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: write
  pages: write
  id-token: write


# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: "🛒 Checkout repository"
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      
      - name: "🐍 Install Python"
        uses: actions/setup-python@v4
        with:
          python-version: '3.9'
      
      - uses: actions/cache@v3
        with:
          key: ${{ github.ref }}
          path: .cache
      
      - name: "📜 Install Poetry"
        uses: abatilo/actions-poetry@v2
        with:
          poetry-version: 1.3.2

      - name: "🔍 Install dependencies"
        run: poetry install --with dev,docs

      - name: "📚 Deploy"
        run: poetry run mkdocs gh-deploy --force