Skip to content

Commit

Permalink
Fix GitHub docs deployment, reduce redundant folder structure, pin in…
Browse files Browse the repository at this point in the history
…take below v2.0 (#65)

### What kind of change does this PR introduce?

* Points the GitHub Docs deployment workflow at the right folder.
* Reduces the number of folder levels (should be ported to cookiecutter as well)
* Pins intake below v2.0

### Does this PR introduce a breaking change?

No.

### Other information:

New `intake` just dropped; Doesn't seem to be compatible with some
dependencies. https://pypi.org/project/intake/2.0.0/

More information:
https://github.com/intake/intake/blob/master/README_refactor.md
  • Loading branch information
Zeitsperre authored Feb 3, 2024
2 parents 9b5e47b + 9e7cc89 commit 2dd0bca
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ jobs:
uses: JamesIves/[email protected]
with:
branch: gh-pages # The branch the action should deploy to.
folder: docs/_build/html # The folder the action should deploy.
folder: docs/_build/en/html # The folder the action should deploy.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,13 @@ linkcheck: autodoc ## run checks over all external links found throughout the do
$(MAKE) -C docs linkcheck

docs: autodoc ## generate Sphinx HTML documentation, including API docs
$(MAKE) -C docs html BUILDDIR="_build/html/en"
$(MAKE) -C docs html BUILDDIR="_build/en"
ifneq ("$(wildcard $(LOCALES))","")
${MAKE} -C docs gettext
$(MAKE) -C docs html BUILDDIR="_build/html/fr" SPHINXOPTS="-D language='fr'"
$(MAKE) -C docs html BUILDDIR="_build/fr" SPHINXOPTS="-D language='fr'"
endif
ifndef READTHEDOCS
$(BROWSER) docs/_build/html/en/html/index.html
$(BROWSER) docs/_build/en/html/index.html
endif

servedocs: docs ## compile the docs watching for changes
Expand Down
2 changes: 1 addition & 1 deletion environment-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ dependencies:
- dask
- dask-geopandas
- geopandas
- intake
- intake <2.0
- intake-geopandas
- intake-xarray >=0.6.1
- ipykernel
Expand Down
2 changes: 1 addition & 1 deletion environment-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dependencies:
- furo
- geoviews
- hvplot
- intake
- intake <2.0.0
- intake-geopandas
- intake-xarray >=0.6.1
- ipykernel
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ dependencies = [
"dask[array]>=2.6",
"dask-geopandas",
"geopandas",
"intake",
"intake<2.0.0",
"intake-xarray>=0.6.1",
"intake-geopandas",
"ipython",
Expand Down

0 comments on commit 2dd0bca

Please sign in to comment.