docs.yml

---
name: Build Documentation

on:
  pull_request:
    branches: [main]
    paths:
      - tests/*
      - hydromt/*
      - data/*
      - docs/*
      - examples/*
      - pyproject.toml

jobs:
  Docs:
    name: linux docs
    runs-on: ubuntu-latest
    env:
      DOC_VERSION: dev
    defaults:
      run:
        shell: bash -l {0}
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
      cancel-in-progress: true
    steps:
      - uses: actions/checkout@v3

      - name: Setup Mambaforge
        uses: conda-incubator/setup-miniconda@v2
        with:
            python-version: 3.11
            miniforge-variant: Mambaforge
            miniforge-version: latest
            channels: conda-forge
            activate-environment: hydromt
            use-mamba: true
      - name: Generate env spec
        run: python make_env.py doc


      - name: Set cache date
        run: echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV

      - uses: actions/cache@v2
        with:
          path: /usr/share/miniconda3/envs/hydromt
          key: docs-conda-${{ hashFiles('environment.yml') }}-${{ env.DATE }}
        id: cache

      - name: Update environment
        run: mamba env update -n hydromt -f environment.yml
        if: steps.cache.outputs.cache-hit != 'true'

      - name: Install hydromt
        run: pip install .

      - name: Build docs
        run: |
          make html

      - name: Set doc version
        run: echo "DOC_VERSION=$(python -c 'from hydromt import __version__ as v; print("dev" if "dev" in v else "v"+v.replace(".dev",""))')" >> $GITHUB_ENV

      - name: Upload to GitHub Pages
        if: ${{ github.event_name == 'pull_request' && github.event.pull_request.merged == true && !github.event.act }}
        uses: peaceiris/actions-gh-pages@v3.8.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build/html
          exclude_assets: .buildinfo,_sources/*,_examples/*.ipynb
          destination_dir: ./${{ env.DOC_VERSION }}
          keep_files: false
          full_commit_message: Deploy ${{ env.DOC_VERSION }} to GitHub Pages