Skip to content

Merge pull request #765 from MetOffice/750_data_time_cycling #404

Merge pull request #765 from MetOffice/750_data_time_cycling

Merge pull request #765 from MetOffice/750_data_time_cycling #404

Workflow file for this run

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:
- name: Checkout code
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
- name: Cache conda environment
id: conda-env-cache
uses: actions/cache@3624ceb22c1c5a301c8db4169662070a689d9ea8
with:
key: conda|${{runner.os}}-${{runner.arch}}|${{hashFiles('requirements/locks/py312-lock-linux-64.txt')}}
path: |
~/conda-env
~/.local/share/cartopy
- name: Create conda environment
if: steps.conda-env-cache.outputs.cache-hit != 'true'
run: |
# Check cache hasn't pulled a partial key match.
test ! -e "${HOME}/conda-env"
conda create --prefix="${HOME}/conda-env" --file=requirements/locks/py312-lock-linux-64.txt
- name: Add conda environment to PATH
run: echo "${HOME}/conda-env/bin" >> $GITHUB_PATH
- name: Build documentation
run: |
# Install module so it can be imported during docs generation.
echo '::group::Installing local package'
python3 -m pip install .
echo '::endgroup::'
# Generate the documentation
echo '::group::Building the documentation'
sphinx-build -b html --color "docs/source" "docs/build/html"
echo '::endgroup::'
- uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882
with:
name: html-docs
path: docs/build/html/
retention-days: 1
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@fa0a91b85d4f404e444e00e005971372dc801d16
with:
name: html-docs
- uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa
with:
path: "."
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e