-
Notifications
You must be signed in to change notification settings - Fork 124
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add developer requirements to setup.py
#712
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.
I just noticed that math does not render properly, trying to fix that now... |
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 |
The instructions look clear. @emanuel-schmid : could you please review for functionality? |
# Conflicts: # CHANGELOG.md
Everything could be so nice - but, alas!, Windows! 🙄
Let's see what google can tell me about this one... |
Actually quite easy:
|
Changes proposed in this PR:
Remove
env_developer.yml
and move the developer requirement specifications intoextras
insetup.py
.setup.py
now defines three extras,doc
for the documentation,test
for the test tools, and a convenience extradev
which combines the two.Remove
pip
specs fromenv_climada.yml
. Pip will now only be called once and install all remaining packages when Climada is installed.Switch from
nbsphinx
tomyst_nb
for parsing Jupyter Notebooks for the documentation.We previously specified both packages as requirements but only used
nbsphinx
. However,nbsphinx
requirespandoc
which 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.yml
to install the docs requirements fromsetup.py
. Alternatively, theenv_doc.yml
could be updatedThis PR fixes #696
PR Author Checklist
develop
)[ ] Tests updatedPR Reviewer Checklist