From b6c16ed179e9a7bb8902957161adfcbaa18ee2bc Mon Sep 17 00:00:00 2001 From: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 23 Nov 2023 15:37:11 -0500 Subject: [PATCH 1/3] use latest commit --- .cruft.json | 2 +- CONTRIBUTING.rst | 2 +- Makefile | 4 ++-- environment_docs.yml => environment-docs.yml | 0 pyproject.toml | 23 +++++++++----------- 5 files changed, 14 insertions(+), 17 deletions(-) rename environment_docs.yml => environment-docs.yml (100%) diff --git a/.cruft.json b/.cruft.json index 3df0643..1e363da 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "https://github.com/Ouranosinc/cookiecutter-pypackage", - "commit": "e528361615f8bb4b886206b9cd49ffda76c45b45", + "commit": "58b13f0c37691917bc5089ee2ff7c650dede5b06", "checkout": null, "context": { "cookiecutter": { diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b5dc0df..f1e0367 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -63,7 +63,7 @@ Ready to contribute? Here's how to set up ``xdatasets`` for local development. $ mamba env create -f environment-dev.yml $ conda activate xdatasets - $ flit install --symlink . + $ flit install --symlink #. To ensure a consistent style, please install the pre-commit hooks to your repo:: diff --git a/Makefile b/Makefile index c2a336a..86a806c 100644 --- a/Makefile +++ b/Makefile @@ -102,7 +102,7 @@ release: dist ## package and upload a release python -m flit publish dist/* install: clean ## install the package to the active Python's site-packages - python -m flit install . + python -m flit install dev: clean ## install the package to the active Python's site-packages - python -m flit install --symlink . + python -m flit install --symlink diff --git a/environment_docs.yml b/environment-docs.yml similarity index 100% rename from environment_docs.yml rename to environment-docs.yml diff --git a/pyproject.toml b/pyproject.toml index fee2889..3b0d1b0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -169,22 +169,22 @@ include = [ "LICENSE", "Makefile", "README.rst", - "docs/**/*.gif", - "docs/**/*.ipynb", - "docs/**/*.jpg", - "docs/**/*.png", - "docs/**/*.rst", + "environment-dev.yml", + "environment-docs.yml", + "docs/_static/_images/*.gif", + "docs/_static/_images/*.jpg", + "docs/_static/_images/*.png", + "docs/_static/_images/*.rst", "docs/Makefile", "docs/conf.py", "docs/make.bat", - "setup.cfg", "tests/*.py", "tox.ini", - "xdatasets/**/*.py" + "xdatasets" ] exclude = [ - "**/*.py[co]", - "**/__pycache__", + "*.py[co]", + "__pycache__", ".coveralls.yml", ".cruft.json", ".editorconfig", @@ -194,12 +194,9 @@ exclude = [ ".pre-commit-config.yaml", ".readthedocs.yml", ".yamllint.yaml", - "Makefile", "docs/_*", "docs/modules.rst", - "docs/xdatasets*.rst", - "environment-docs.yml", - "environment-dev.yml" + "docs/xdatasets*.rst" ] [tool.isort] From 07476021171fddc0441e5199d379e7868917da81 Mon Sep 17 00:00:00 2001 From: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 23 Nov 2023 15:42:24 -0500 Subject: [PATCH 2/3] specify apidoc folder --- .cruft.json | 2 +- pyproject.toml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.cruft.json b/.cruft.json index 1e363da..8c50863 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "https://github.com/Ouranosinc/cookiecutter-pypackage", - "commit": "58b13f0c37691917bc5089ee2ff7c650dede5b06", + "commit": "65a4313b060df132d83623006c5d7241ba734d9b", "checkout": null, "context": { "cookiecutter": { diff --git a/pyproject.toml b/pyproject.toml index 3b0d1b0..ad25b54 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -195,8 +195,8 @@ exclude = [ ".readthedocs.yml", ".yamllint.yaml", "docs/_*", - "docs/modules.rst", - "docs/xdatasets*.rst" + "docs/apidoc/modules.rst", + "docs/apidoc/xdatasets*.rst" ] [tool.isort] From 63de526a97cac680b33b71d6400475bdbe75dbc0 Mon Sep 17 00:00:00 2001 From: Trevor James Smith <10819524+Zeitsperre@users.noreply.github.com> Date: Thu, 23 Nov 2023 15:46:06 -0500 Subject: [PATCH 3/3] typo fix --- .github/workflows/gh-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 91bd96c..679960f 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -27,7 +27,7 @@ jobs: uses: mamba-org/setup-micromamba@v1 with: cache-downloads: true - environment-file: environment_docs.yml + environment-file: environment-docs.yml - name: Install xdatasets (docs) run: | python -m ipykernel install --user --name=xdatasets