Skip to content

Merge pull request #81 from ioos/dependabot/pre_commit/https-/github.… #129

Merge pull request #81 from ioos/dependabot/pre_commit/https-/github.…

Merge pull request #81 from ioos/dependabot/pre_commit/https-/github.… #129

Workflow file for this run

name: Documentation
# no permissions by default
permissions: {}
on:
pull_request:
push:
branches:
- main
release:
types:
- published
jobs:
build-docs:
runs-on: ubuntu-latest
permissions:
contents: write
defaults:
run:
shell: bash -l {0}
steps:
- name: checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
persist-credentials: false
- name: Setup Micromamba
uses: mamba-org/setup-micromamba@f457c30a868e4760d3a6fcea5f25dc655b8edf39 # v3.2.1
with:
environment-name: TEST
init-shell: bash
create-args: >-
python=3 pip
--file requirements.txt
--file requirements-dev.txt
--channel conda-forge
- name: Install package
run: |
python -m pip install -e . --no-deps --force-reinstall
- name: Build documentation
run: |
set -e
jupyter nbconvert --to notebook --execute notebooks/tutorial.ipynb --output=tutorial-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@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html