Add developer requirements to setup.py#712
Merged
emanuel-schmid merged 11 commits intodevelopfrom May 12, 2023
Merged
Conversation
* Remove `requirements/env_developer.yml`. * Add extras for docs and test to `setup.py`. * Fix requirements: - Remove descartes, it was not used. - Remove pandoc in favor of myst_nb.
Member
Author
|
I just noticed that math does not render properly, trying to fix that now... |
Member
Author
|
Math is rendering now. However, the "Contents" links in the tutorials broke (for the online documentation only). This is because myst uses a different anchor slug structure than nbsphinx. I think we can leave it as is. https://github.com/CLIMADA-project/climada_python/pull/712/files#diff-cfbe05e73a29504cae64178b403c69f5c532ccf3abeb4e14c66b96e137ca642c shows an example how to fix them |
Member
|
The instructions look clear. @emanuel-schmid : could you please review for functionality? |
# Conflicts: # CHANGELOG.md
Collaborator
|
Everything could be so nice - but, alas!, Windows! 🙄 Let's see what google can tell me about this one... |
Collaborator
|
Actually quite easy: |
13 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Changes proposed in this PR:
Remove
env_developer.ymland move the developer requirement specifications intoextrasinsetup.py.setup.pynow defines three extras,docfor the documentation,testfor the test tools, and a convenience extradevwhich combines the two.Remove
pipspecs fromenv_climada.yml. Pip will now only be called once and install all remaining packages when Climada is installed.Switch from
nbsphinxtomyst_nbfor parsing Jupyter Notebooks for the documentation.We previously specified both packages as requirements but only used
nbsphinx. However,nbsphinxrequirespandocwhich cannot be installed via pip. To remove the pandoc requirement from the conda environment, I switched to myst-nb, which works the same way, can be installed via pip, and seems to support more features. From what I can see, this did not change anything in the display of the notebooks (reviewer please double check that!)Update
.readthedocs.ymlto install the docs requirements fromsetup.py. Alternatively, theenv_doc.ymlcould be updatedThis PR fixes #696
PR Author Checklist
develop)[ ] Tests updatedPR Reviewer Checklist