cleaner environment #30
Merged
Conversation
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
Zeitsperre
approved these changes
Sep 13, 2023
| @@ -19,7 +19,7 @@ build: | |||
| - sphinx-apidoc -o docs/apidoc --private --module-first xhydro | |||
|
|
|||
| conda: | |||
| environment: environment-docs.yml | |||
| environment: environment-dev.yml | |||
There was a problem hiding this comment.
Like I mentioned in person, there are a few ways of going about building the docs:
- We can install everything from the dev environment and evaluate notebooks (heavy on resources/memory, slower to build)
- We can mock the dependencies and install the library without any intention of running notebooks (faster, no gurantee that notebooks are running properly on RtD).
- We can do something fancier (like I developed in xclim).
Any of these approaches is fine. If we find that option 1 ends up being too slow, I can make something more custom resembling option 3 later...
| "xclim>=0.43.0", | ||
| "zarr>=2.11.1", | ||
| ] | ||
| requirements = [] |
There was a problem hiding this comment.
@RondeauG and I spoke about this earlier. As we start adding content to xhydro, we should progressvely add requirements here. That way it doesn`t take so long to install/test in the early stages.
| @@ -69,9 +40,7 @@ | |||
| name="xhydro", | |||
| packages=find_packages(include=["xhydro", "xhydro.*"]), | |||
| test_suite="tests", | |||
| tests_require=test_requirements, | |||
There was a problem hiding this comment.
This field is deprecated and the pytest and setuptools maintainers suggest against using it. Good call.
More info: https://docs.pytest.org/en/latest/explanation/goodpractices.html#do-not-run-via-setuptools
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist:
number) and pull request (:pull:number) has been added.What kind of change does this PR introduce?
environment.ymlfile now only contains the bare minimum dependencies.-docsand moved everything into aenvironment-dev.requirements_(dev/docs).txt, since they were not used.Does this PR introduce a breaking change?
Other information: