deploy.yml

name: Deploy docs

on:
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Cache pip
        uses: actions/cache@v4
        with:
          path: ~/.cache/pip
          key: pip-${{ runner.os }}-${{ hashFiles('docs/requirements.txt') }}

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          # mkdocs + plugins only. mkdocstrings/griffe reads the DeepLens
          # docstrings by static source analysis (no import), so the deeplens-src
          # submodule does NOT need to be pip-installed — see mkdocs.yml `paths`.
          pip install -r docs/requirements.txt

      - name: Build and deploy to gh-pages
        run: mkdocs gh-deploy --force --no-history