New notebook #166
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | |
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 |