build_docs.yaml

name: Publish Docs

on:
  push:
    branches: [ main ]
  release:
    types: [ released ]

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
  cancel-in-progress: true

jobs:
  docs:
    name: Publish Docs
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
        with:
          persist-credentials: false

      - name: Setup Conda
        uses: mamba-org/setup-micromamba@v2
        with:
          init-shell: bash
          environment-name: docs
          create-args: >-
            python=3.11
            cython
            proj

      - name: Install and Build
        shell: bash
        run: |
          micromamba run -n docs python -m pip install -e .
          micromamba run -n docs python -m pip install -r requirements-docs.txt
          micromamba run -n docs sphinx-build -b html docs/ docs/_build/

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4
        if: ${{ github.event_name == 'release' }}
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages
          folder: docs/_build/
          clean: false
          target-folder: ${{ github.ref_name }}

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4
        if: ${{ github.event_name == 'push' }}
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          branch: gh-pages
          folder: docs/_build/
          clean: false
          target-folder: latest