Skip to content

Merge pull request #219 from pyoceans/pre-commit-ci-update-config #185

Merge pull request #219 from pyoceans/pre-commit-ci-update-config

Merge pull request #219 from pyoceans/pre-commit-ci-update-config #185

Workflow file for this run

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 Python
uses: mamba-org/setup-micromamba@v2
with:
environment-name: TEST
init-shell: bash
create-args: >-
python=3 --file requirements.txt --file requirements-dev.txt --channel conda-forge
- name: Install ctd
shell: bash -l {0}
run: |
python -m pip install -e . --no-deps --force-reinstall
- name: Build documentation
shell: bash -l {0}
run: >
set -e
&& jupyter nbconvert --to notebook --execute notebooks/quick_intro.ipynb --output=quick_intro-output.ipynb
&& mv notebooks/*output.ipynb docs/source/
&& 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