Skip to content

[pre-commit.ci] pre-commit autoupdate #177

[pre-commit.ci] pre-commit autoupdate

[pre-commit.ci] pre-commit autoupdate #177

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 ${{ matrix.python-version }}
uses: mamba-org/setup-micromamba@v1
with:
environment-name: TEST
init-shell: bash
create-args: >-
python=3 pip
--file requirements.txt
--file requirements-dev.txt
--channel conda-forge
- name: Install gliderpy
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/01-plotting_intro.ipynb --output=01-plotting_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