deploy-docs.yml

name: Build and Deploy docs

on:
  pull_request:
  push:
    branches:
      - master
  release:
    types:
      - published

# Deny all permissions by default
permissions: {}

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

    steps:
    - name: checkout
      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
      with:
        fetch-depth: 0
        persist-credentials: false

    - name: Setup Mamba
      uses: mamba-org/setup-micromamba@d7c9bd84e824b79d2af72a2d4196c7f4300d3476 # v3.0.0
      with:
        environment-name: TEST
        create-args: >-
          python=3
          numpy>1.13.3
          sphinx

    - name: Build environment
      shell: bash -l {0}
      run: |
        python -m pip install -e . --no-deps --force-reinstall

    - name: Get the version
      shell: bash -l {0}
      id: get_version
      run: echo "name=VERSION::$(python setup.py --version)" >> $GITHUB_OUTPUT

    - name: Build documentation
      shell: bash -l {0}
      run: |
        set -e
        pushd docs
        make html linkcheck O=-W
        popd

    - name: Deploy
      if: success() && github.event_name == 'release'
      uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453  # v4.1.0
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: docs/_build/html