Skip to content

Update pyproject.toml to remove geopandas v1.0.0 reference #522

Update pyproject.toml to remove geopandas v1.0.0 reference

Update pyproject.toml to remove geopandas v1.0.0 reference #522

Workflow file for this run

name: Build Documentation
on:
workflow_dispatch:
push:
branches: [main]
paths:
- .github/workflows/docs.yml
- hydromt_sfincs/*
- docs/*
- examples/*
- pyproject.toml
pull_request:
branches: [main]
paths:
- .github/workflows/docs.yml
- hydromt_sfincs/*
- docs/*
- examples/*
- pyproject.toml
jobs:
# Build docs on Linux
test-docs:
env:
DOC_VERSION: dev
PYDEVD_DISABLE_FILE_VALIDATION: 1
timeout-minutes: 30
runs-on: ubuntu-latest
steps:
- name: checkout code
uses: actions/checkout@v3
- name: Setup Mambaforge
uses: conda-incubator/setup-miniconda@v2
with:
python-version: '3.11'
miniforge-variant: Mambaforge
miniforge-version: latest
use-mamba: true
- name: Setup env
run: |
python make_env.py full -p 3.11 -n hydromt-sfincs -o environment-doc.yml
mamba env create -f environment-doc.yml
mamba run -n hydromt-sfincs pip install -e .
# if we're not publishing we don't have to write them, so we might as well
# save ourself a bunch of IO time
- name: Build dummy docs
if: ${{ github.event_name == 'pull_request' }}
run: |
mamba run -n hydromt-sfincs sphinx-build ./docs ./docs/_build -b dummy -W
- name: Build html docs
if: ${{ github.event_name != 'pull_request' }}
run: |
mamba run -n hydromt-sfincs sphinx-build -M html ./docs ./docs/_build -W
echo "DOC_VERSION=$(mamba run -n hydromt-sfincs python -c 'from hydromt_sfincs import __version__ as v; print("dev" if "dev" in v else "v"+v)')" >> $GITHUB_ENV
- name: Upload to GitHub Pages
if: ${{ github.event_name != 'pull_request'}}
uses: peaceiris/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
exclude_assets: '.buildinfo,_sources/*,_examples/*.ipynb'
destination_dir: ./${{ env.DOC_VERSION }}
keep_files: false
full_commit_message: Deploy ${{ env.DOC_VERSION }} to GitHub Pages