docs.yml

name: Build Docs

# We don't want pushes (or PRs) to gh-pages to kick anything off
on:
  push:
    branches:
      - main
      - '[0-9]+.[0-9]+.x'
    tags:
      - v[0-9]+.[0-9]+.[0-9]+
  pull_request:
  release:
    types: [published]

permissions:
  contents: write

jobs:
  #
  # Build our docs on Linux against multiple Pythons
  #
  Docs:
    name: ${{ matrix.python-version }} ${{ matrix.dep-versions }}
    runs-on: ubuntu-20.04
    env:
      DOC_VERSION: dev
    environment:
      name: github-pages
    strategy:
      fail-fast: false
      matrix:
        include:
          - python-version: 3.8
            check-links: false
            dep-versions: requirements.txt
          - python-version: 3.9
            check-links: true
            dep-versions: requirements.txt

    steps:
    # We check out only a limited depth and then pull tags to save time
    - name: Checkout source
      uses: actions/checkout@v2.3.5
      with:
        fetch-depth: 100

    - name: Get tags
      run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2.2.2
      with:
        python-version: ${{ matrix.python-version }}

    # This uses pip to find the right cache dir and then sets up caching for it
    - name: Get pip cache dir
      id: pip-cache
      run: echo "::set-output name=dir::$(pip cache dir)"

    - name: Setup pip cache
      uses: actions/cache@v2.1.6
      with:
        path: ${{ steps.pip-cache.outputs.dir }}
        key: pip-docs-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('ci/*') }}
        restore-keys: |
          pip-docs-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('ci/*') }}
          pip-docs-${{ runner.os }}-${{ matrix.python-version }}-
          pip-docs-${{ runner.os }}-
          pip-docs-

    # This installs the stuff needed to build and install Shapely and CartoPy from source.
    - name: Install dependencies (PyPI)
      run: |
        sudo apt-get install libgeos-dev libproj-dev proj-bin
        python -m pip install --upgrade pip setuptools
        python -m pip install --no-binary :all: shapely
        python -m pip install -r ci/doc_requirements.txt -r ci/extra_requirements.txt -c ci/${{ matrix.dep-versions }}

    - name: Download Cartopy Maps
      run: ci/download_cartopy_maps.py

    - name: Install self
      run: python -m pip install -c ci/${{ matrix.dep-versions }} .

    - name: Build docs
      run: |
        export TEST_DATA_DIR=$GITHUB_WORKSPACE/staticdata
        pushd docs
        make overridecheck html O=-W
        popd

    - name: Enable linkchecker for PRs
      # Doing the linkchecker separately so that we avoid problems with vendored LICENSE
      # files in the build directory
      if: ${{ github.event_name == 'pull_request' && matrix.check-links == true }}
      run: |
        pushd docs
        find build/html/_static -name LICENSE.md -delete
        make linkcheck
        popd

    - name: Upload docs as artifact
      if: ${{ github.event_name == 'pull_request' }}
      uses: actions/upload-artifact@v2
      with:
        name: ${{ matrix.python-version }}-${{ matrix.dep-versions }}-docs
        path: |
          docs/build/html
          !docs/_static/*.pdf

    # This overrides the version "dev" with the proper version if we're building off a
    # branch that's not main (which is confined to n.nn.x above) or on a tag.
    - name: Set doc version
      if: ${{ github.event_name != 'push' || !contains(github.ref, 'main') }}
      run: echo "DOC_VERSION=v$(python -c 'import metpy,re; print(re.search(r"(\d+\.\d+)", metpy.__version__)[0])')" >> $GITHUB_ENV

    - name: Upload to GitHub Pages
      if: ${{ github.event_name != 'pull_request' && matrix.python-version == '3.9' }}
      uses: peaceiris/actions-gh-pages@v3.8.0
      with:
        deploy_key: ${{ secrets.GHPAGES_DEPLOY_KEY }}
        publish_dir: ./docs/build/html
        exclude_assets: '.buildinfo,_static/jquery-*.js,_static/underscore-*.js'
        destination_dir: ./${{ env.DOC_VERSION }}
        keep_files: false
        full_commit_message: Deploy ${{ env.DOC_VERSION }} to GitHub Pages