Work towards a 2.0 release #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| release: | |
| types: | |
| - published | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Micromamba | |
| uses: mamba-org/setup-micromamba@v2 | |
| with: | |
| environment-name: TEST | |
| init-shell: bash | |
| create-args: >- | |
| python=3 pip pyspharm iris xarray sphinx sphinx-issues --channel conda-forge | |
| - name: Install windspharm | |
| shell: bash -l {0} | |
| run: | | |
| python -m pip install -e . --no-deps --force-reinstall | |
| - name: Build documentation | |
| shell: bash -l {0} | |
| run: | | |
| set -e | |
| micromamba activate TEST | |
| pushd docs | |
| make clean html linkcheck | |
| popd | |
| - name: Deploy | |
| if: success() && github.event_name == 'release' | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/_build/html |