docs_deploy.yml

name: Deploy Documentation

on:
  push:
    branches:
      - main
  # Optional: manual trigger
  workflow_dispatch:

jobs:
  deploy-docs:
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
      - name: Checkout
        uses: actions/checkout@v7
        with:
          fetch-depth: 0

      - name: Setup Micromamba
        uses: mamba-org/setup-micromamba@v3
        with:
          environment-file: docs/environment.yml
          init-shell: bash
          condarc: |
            channels:
              - conda-forge
            channel_priority: strict
          cache-environment: true

      - name: Install package (editable)
        shell: bash -l {0}
        run: |
          micromamba run -n oceanarray python -m pip install --upgrade pip
          micromamba run -n oceanarray python -m pip install -e ".[dev]" --force-reinstall

      - name: Build documentation
        shell: bash -l {0}
        run: |
          set -e
          micromamba run -n oceanarray jupyter nbconvert --to notebook --execute notebooks/demo_mooring.ipynb --output=demo_mooring-output.ipynb
          mv notebooks/*output.ipynb docs/source/
          pushd docs
          micromamba run -n oceanarray make clean html
          popd

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: docs/build/html
          # Optional: publish_branch: gh-pages
          # Optional: cname: docs.example.org
          # Replace gh-pages with a single commit each deploy. The built site is
          # regenerable, so its history has no value. The saving is smaller than it
          # looks: git deltas near-identical HTML well, and squashing 70-120 deploys
          # shrinks a fresh clone by only 4-18%. What it does bound is the growth from
          # re-executed demo notebooks, whose embedded PNGs differ every build and so
          # never delta. Current site size dominates, not history - keep _static small.
          force_orphan: true