-
Notifications
You must be signed in to change notification settings - Fork 285
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
rtd with latest mambaforge image for faster building #4476
rtd with latest mambaforge image for faster building #4476
Conversation
@tkknight Also I question our need to support It adds to the built time... and who actually needs or uses these formats? Do we know? 🤔 I've certainly never relied on them... ever. |
I enable the html and pdf options as it was easy to do so and thought some may find it useful. A quick look at other RTD hosted docs didnt show much uptake of it either - so yeah +1 for removing these two build targets. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
@tkknight Thanks. I'll remove the |
d98adfd
to
aff05e0
Compare
So we're now down to about |
Back to you @tkknight after a wierd CI barf |
... the days of |
* main: rtd with latest mambaforge image for faster building (SciTools#4476) Show acceptable image test results in the docs (SciTools#4392) Nc load latlon fix (SciTools#4470) update matplotlib links (SciTools#4474) Whatsnew for PR 4462 (SciTools#4475) Clarify the return type of iris.load (AVD-1899) (SciTools#4462) [pre-commit.ci] pre-commit autoupdate (SciTools#4472) Updated environment lockfiles (SciTools#4467)
Awesome, thanks @tkknight 😄 |
* main: Use partial to make cube pickleable (SciTools#4377) Add edit via github method to Iris docs (SciTools#4461) Broken cartopy links in docs (SciTools#4464) rtd with latest mambaforge image for faster building (SciTools#4476) Show acceptable image test results in the docs (SciTools#4392) Nc load latlon fix (SciTools#4470) update matplotlib links (SciTools#4474) Whatsnew for PR 4462 (SciTools#4475) Clarify the return type of iris.load (AVD-1899) (SciTools#4462) [pre-commit.ci] pre-commit autoupdate (SciTools#4472) Updated environment lockfiles (SciTools#4467)
🚀 Pull Request
Description
This PR adopts the latest
mambaforge
image workflow from RTD to build our documentation, replacing our previous use of the RTD Legacy build specification.When using the legacy RTD specification, typically I've seen documentation builds taking between
670-730 seconds
.Using the latest
mambaforge
image, this PR built its documentation in454 seconds
... which is quite an improvement 🚀(although, this is only a sample of one 😉)
The built documentation associated with this PR can be viewed here, and the raw RTD build log can be viewed here.
Consult Iris pull request check list