Skip to content

Merge pull request #378 from ioos/dependabot/github_actions/github-ac… #275

Merge pull request #378 from ioos/dependabot/github_actions/github-ac…

Merge pull request #378 from ioos/dependabot/github_actions/github-ac… #275

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@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
fetch-depth: 0
- name: Setup Micromamba
uses: mamba-org/setup-micromamba@06375d89d211a1232ef63355742e9e2e564bc7f7 #v1
with:
environment-name: TEST
init-shell: bash
create-args: >-
python=3 --file requirements.txt --file requirements-dev.txt --channel conda-forge
- name: Install erddapy
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/00-quick_intro.ipynb --output=00-quick_intro-output.ipynb
&& jupyter nbconvert --to notebook --execute notebooks/01a-griddap.ipynb --output=01a-griddap-output.ipynb
&& jupyter nbconvert --to notebook --execute notebooks/01b-tabledap.ipynb --output=01b-tabledap-output.ipynb
&& jupyter nbconvert --to notebook --execute notebooks/02-extras.ipynb --output=02-extras-output.ipynb
&& jupyter nbconvert --to notebook --execute notebooks/03-advanced_search.ipynb --output=03-advanced_search-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@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e #v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html