Skip to content
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

suppress installing and reinstalling deps with pip at readthedocs builds #2913

Merged
merged 4 commits into from
Nov 14, 2022

Conversation

valeriupredoi
Copy link
Contributor

@valeriupredoi valeriupredoi commented Nov 9, 2022

Readthedocs builds use pip install --upgrade --upgrade-strategy eager to install and eventually reinstall everything from the env via pip - this is discussed in readthedocs/readthedocs.org#8890 and is not something good for many reasons, one of them, and a very recent and pertinent one is that the build will chuck a wobbly if the package versions differ from conda-forge to pypi. I am trying to fix this here via the readthedocs build conf file.

EDIT by some miracle I found the magic incantation to get this done, and supported by the Readthedocs API too - @bouweandela do you recommend using pip install -e .[doc] instead of pip install -e .[develop]?

Docs built with this PR: https://esmvaltool--2913.org.readthedocs.build/en/2913/
Closes #2903 once and for all

@valeriupredoi
Copy link
Contributor Author

BTW if anyone is interested in discussion this more with the Readthedocs folk, I opened an issue there readthedocs/readthedocs.org#9727

Copy link
Member

@bouweandela bouweandela left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great find @valeriupredoi, I didn't know this was possible!

.readthedocs.yaml Outdated Show resolved Hide resolved
Co-authored-by: Bouwe Andela <[email protected]>
@valeriupredoi
Copy link
Contributor Author

Great find @valeriupredoi, I didn't know this was possible!

cheers, bud! Pretty nifty option, and well buried in their documentation 🐶

@valeriupredoi
Copy link
Contributor Author

thanks a lot for looking and reviewing @bouweandela 🍺 Can any of the @ESMValGroup/technical-lead-development-team please have a quick look and merge? 🍻

@valeriupredoi valeriupredoi merged commit 6c12869 into main Nov 14, 2022
@valeriupredoi valeriupredoi deleted the suppress_pip_at_buildthedocs branch November 14, 2022 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc build failing
2 participants