Skip to content

Update docs to GEBCO 2024 (#123) #81

Update docs to GEBCO 2024 (#123)

Update docs to GEBCO 2024 (#123) #81

Workflow file for this run

#
# Build documentation and deploy
#
name: Docs
on:
# pull_request:
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/**'
defaults:
run:
# default to use bash shell
shell: bash
jobs:
build:
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE
- name: Checkout
uses: actions/[email protected]
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install requirements
run: pip install -r requirements.txt
- name: Build the website
run: make -C docs clean html
- name: Deploy to gh-pages
if: success() && github.event_name == 'push'
# Don't use tags: https://julienrenaux.fr/2019/12/20/github-actions-security-risk/
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html/
# Only keep the latest commit to avoid bloating the repository
force_orphan: true
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'