Repository navigation
Update Read the Docs configuration (automatic) - #7763
Conversation
The following migrators were applied: - Convert the Python version to a string. This makes the configuration valid according to the schema and protects you from ["the Python 3.1 problem"](https://dev.to/hugovk/the-python-3-1-problem-85g). - Migrate to `build.tools` configuration. This uses the new base Docker image based on Ubuntu 20.04 introduced in October 2021 and picks an appropriate Python version for your project (read [our blog post](https://blog.readthedocs.com/new-build-specification/) for details). Notice that now you can specify the Node.js, Rust, and Go versions as well. *Note:* Some system dependencies are not preinstalled anymore, so this might require manually adding them to `build.apt_packages` (see [our documentation](https://docs.readthedocs.io/en/stable/config-file/v2.html#build-apt-packages>)). - Migrate to Mamba as a drop-in replacement for Conda. Your project requested using Mamba instead of Conda for performance reasons. Now this is included in your configuration and you can change it without our intervention.
gmarkall
left a comment
gmarkall
left a comment
There was a problem hiding this comment.
I don't understand the changes here (and I know we had to have some custom setup for RTD) - however, a brief look over the docs generated by this PR suggests that they are OK.
|
Hi @gmarkall , if the changes are not easily understood by the bot message, that's a bug 😄 The key is here:
In #7182 (comment) we discussed that, at that time, the conda version installed in RTD was too old and that enabling mamba fixed the builds. We did so by flipping an internal feature flag, This pull request upgrades the RTD configuration so that Mamba is explicitly requested in the configuration without having to reach out to us. Alternatively, if you would like to go back to conda, you could do so without our intervention by changing the |
Thanks for the reply @astrojuanlu, and apologies for some confusion - the message from the bot is quite clear, but I omitted some context from my comment - my understanding was that somehow we were already using mamba for RTD, and that we had some other hacks for building the documentation elsewhere (e.g. using an old docutils version), but I didn't recall the details that you now linked to... I mainly wanted to communicate that the built docs look OK upon my inspection, but that my review / comments shouldn't be taken as an evaluation of anything on the technical side of this PR. Many thanks for all your efforts / work on RTD! |
stuartarchibald
added
3 - Ready for Review
Effort - medium
esc
left a comment
esc
left a comment
There was a problem hiding this comment.
We decided that this looks good and we will merge it!
gmarkall
left a comment
gmarkall
left a comment
There was a problem hiding this comment.
Per triage discussion, let's merge this as it appears good - if any issues arise later we can seek to resolve them then.
esc
added
5 - Ready to merge
6 participants
Howdy! 👋
I am @readthedocs-assistant and I am sending you this pull request to upgrade the configuration of your Read the Docs project.
Your project will continue working whether or not you merge it, but I recommended you take it into consideration.
Also, in case you haven't done it already, remember that you can enable the pull request builds for your project to see the effect of these changes. To do it, follow the instructions, close this pull request, and open it again.
Note: This tool is in beta phase. Don't hesitate to ping @astrojuanlu and/or @humitos if you spot any problems.
The following migrators were applied:
build.toolsconfiguration.This uses the new base Docker image based on Ubuntu 20.04 introduced in October 2021
and picks an appropriate Python version for your project
(read our blog post
for details).
Notice that now you can specify the Node.js, Rust, and Go versions as well.
Note: Some system dependencies are not preinstalled anymore,
so this might require manually adding them to
build.apt_packages(see our
documentation).
Your project requested using Mamba instead of Conda for performance reasons.
Now this is included in your configuration
and you can change it without our intervention.