-
Notifications
You must be signed in to change notification settings - Fork 125
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
Let readthedocs build the documentation environment based on env_climada.yml #687
Conversation
@peanutfun do you know why the Read the Docs build failed? |
Yes, I am trying to install the additional dependencies in the post-install step of the readthedocs build, but the environment is not named |
The readthedocs build now takes 6 minutes, about the time of the unit tests. So I think the longer duration is no issue at this point. |
@chahank @emanuel-schmid This is working! We can ditch |
@emanuel-schmid I recall you were a bit opposed to the idea of having a "flexible" environment for the docs (right?). I would be happy about your approval as well before merging! 🙏 |
🤷 Neither I'm I opposed to the idea of a flexible environment nor am I keen on keeping yet another yml file up to date. It's just that we didn't introduce the env_docs.yml file for the sheer fun of it. Back then, it solved a problem that came up as a surprise, caused by the the straw that breaks the camel's back so to say. At the very moment the problem is not present anymore but there is no guarantee that it won't re-appear one day. In principle, I'm happy to merge this PR nevertheless: when the problems comes back we still can solve it in the same manner. But - right now, the PR doesn't solve a present problem and while we wait with merging we save about 5 minutes of cpu time with each commit on any PR branch and whenever a PR is merged. |
@emanuel-schmid I don't think I agree. For now, there is no apparent problem, but the documentation will break as soon as a branch, e.g., adds a dependency. This PR avoids such issues in the future. Additionally, the build time does not suffer much. The last RTD build on this branch took 575s against 517s on the latest develop build. Anyway, the approach is somewhat appealing. We can merge this when something with the docs breaks. However, we might then have to re-review this PR. |
👍
Yes, but unlike the PR builds the develop build does the latex/pdf stuff too on RTD. PR builds take something between 350s and 400s
I'll take that upon me. 😁 |
Very good. Then let's go with your approach and merge (only) as soon as something breaks 🙌 |
# Conflicts: # CHANGELOG.md
I'm glad this finally became useful 😇 |
…ada.yml (CLIMADA-project#687) * Use env_climada.yml as environment in readthedocs Remove requirements/env_docs.yml * Fix wrong path in doc/README.md * Add note on the removal of requirements/env_docs.yml * Try installing additional packages in readthedocs environment * Try not specifying the readthedocs environment name * Remove custom package installation from RTD config * Fix Python version in RTD build process * Update CHANGELOG.md --------- Co-authored-by: emanuel-schmid <schmide@ethz.ch>
Changes proposed in this PR:
requirements/env_docs.yml
requirements/env_climada.yml
for building the docs. This will take a bit longer because the dependency solver actually has to resolve the environment.This PR fixes #654
PR Author Checklist
develop
)[ ] Tests updatedPR Reviewer Checklist