documentation.yml

name: Documentation

on:
  push:
    branches:
      - main
      - docs

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source code
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.8

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.8

      - name: Restore pip cache
        uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key: pip-3.8

      - name: Upgrade pip and install poetry
        run: python -m pip install --upgrade pip poetry
        shell: bash

      - name: Restore poetry cache
        uses: actions/cache@v4
        with:
          path: |
            ~/.cache/pypoetry/cache
            ~/.cache/pypoetry/artifacts
          key: poetry-cache-and-artifacts-3.8

      - name: Restore virtualenvs
        uses: actions/cache@v4
        with:
          path: ~/.cache/pypoetry/virtualenvs
          key: venv-${{ hashFiles('poetry.lock') }}-3.8

      - name: Poetry install
        run: poetry install --only docs
        shell: bash

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