update docstrings for basemaps (#305) #756
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: Build Documentation | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: [main] | |
| paths: | |
| - tests/* | |
| - hydromt_wflow/* | |
| - docs/* | |
| - examples/* | |
| - pyproject.toml | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - tests/* | |
| - hydromt_wflow/* | |
| - docs/* | |
| - examples/* | |
| - pyproject.toml | |
| jobs: | |
| # Build docs on Linux | |
| Docs: | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: ["ubuntu-latest" ] #, "macos-latest", "windows-latest"] | |
| python-version: ['3.11'] | |
| include: | |
| - os: ubuntu-latest | |
| label: linux-64 | |
| prefix: /usr/share/miniconda3/envs/hydromt_wflow | |
| name: ${{ matrix.label }} | |
| runs-on: ${{ matrix.os }} | |
| timeout-minutes: 30 | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v3 | |
| - name: Generate env yaml | |
| run: | | |
| pip install tomli | |
| python make_env.py doc -p ${{ matrix.python-version }}.* -n hydromt_wflow | |
| - name: Load cache | |
| id: cache | |
| uses: actions/cache/restore@v3 | |
| with: | |
| path: | | |
| /usr/share/miniconda3 | |
| ~/pycache | |
| ./docs/_build | |
| # the below two settings mean we'll alway srestore the cache | |
| # but the cache hit output can tell us if we have to update afterwards | |
| key: docs-${{ hashFiles('environment.yml') }} | |
| restore-keys: | | |
| docs | |
| - name: Failed cache restore | |
| if: steps.cache.outputs.cache-matched-key == '' | |
| run: | | |
| echo "Failed to restore any cache. exiting..." | |
| exit 1 | |
| # by avoiding the mamba setup stage by loading it from cache instead we save | |
| # a lot of setup time, but we do have to do our own PATH management | |
| # hence the exports | |
| - name: Update environment | |
| if: steps.cache.outputs.cache-hit != 'true' | |
| run: | | |
| export PATH=/usr/share/miniconda3/bin:$PATH | |
| mamba env update -n hydromt_wflow -f environment.yml | |
| # - name: Install HydroMT-core dev | |
| # run: | | |
| # export PATH=/usr/share/miniconda3/bin:$PATH | |
| # mamba run -n hydromt_wflow python -m pip install git+https://github.com/Deltares/hydromt.git@main --user | |
| - name: Generate dummy docs | |
| if: ${{ github.event_name == 'pull_request' }} | |
| run: | | |
| export PATH=/usr/share/miniconda3/bin:$PATH | |
| PYTHONPYCACHEPREFIX=~/pycache mamba run -n hydromt_wflow sphinx-build ./docs ./docs/_build -b dummy | |
| - name: Generate docs | |
| if: ${{ github.event_name != 'pull_request' && !github.event.act }} | |
| run: | | |
| export PATH=/usr/share/miniconda3/bin:$PATH | |
| PYTHONPYCACHEPREFIX=~/pycache mamba run -n hydromt_wflow sphinx-build -M html ./docs ./docs/_build | |
| echo "DOC_VERSION=$(mamba run -n hydromt_wflow python -c 'from hydromt_wflow import __version__ as v; print("dev" if "dev" in v else "v"+v.replace(".dev",""))')" >> $GITHUB_ENV | |
| - name: Upload to GitHub Pages | |
| if: ${{ github.event_name != 'pull_request'}} | |
| uses: peaceiris/actions-gh-pages@v3.8.0 | |
| 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 |