docs.yml

name: "Documentation"

on:
  push:
    branches:
      - develop
      - master
  schedule:
    - cron: '37 23 * * 2'

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  generate:
    name: Generate
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Restore cached venv
        id: cache-venv-restore
        uses: actions/cache/restore@v4
        with:
          path: |
            .cache-uv/
            .venv/
          key: ${{ matrix.python-version }}-${{matrix.django-version}}-venv

      - uses: yezz123/setup-uv@v4
      - name: Build Doc
        run: |
          uv sync --extra docs
          PYTHONPATH=./src uv run --cache-dir .cache-uv/ mkdocs build -d ./docs-output

      - name: Cache venv
        if: steps.cache-venv-restore.outputs.cache-hit != 'true'
        id: cache-venv-save
        uses: actions/cache/save@v4
        with:
          path: |
            .cache-uv/
            .venv/
          key: ${{ matrix.python-version }}-${{matrix.django-version}}-venv

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs-output

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: generate
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4