Merge pull request #161 from MetOffice/pre-commit-effd6c4b #96
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: | |
| push: | |
| branches: | |
| - "main" | |
| workflow_dispatch: | |
| # Allow only one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| - name: Install dependencies | |
| run: python3 -m pip install tox tox-conda | |
| - uses: actions/cache@v3 | |
| with: | |
| key: tox|docs|${{ runner.os }}-${{ runner.arch}}|${{ hashFiles('requirements/locks/*') }} | |
| path: .tox | |
| - name: Build documentation | |
| run: tox -e py310-linux-docs | |
| - uses: actions/upload-artifact@v3 | |
| with: | |
| name: html-docs | |
| path: docs/build/html/ | |
| retention-days: 10 | |
| if-no-files-found: error | |
| pages-deploy: | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build-docs | |
| steps: | |
| - uses: actions/download-artifact@v3 | |
| with: | |
| name: html-docs | |
| - uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: "." | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v1 |