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.

Sign up for GitHub

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

fix readthedocs PR builds #1894

Merged
merged 1 commit into from
Oct 17, 2023
Merged

fix readthedocs PR builds #1894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
version: 2
formats: []
build:
image: latest
os: ubuntu-22.04
Copy link
Contributor

Choose a reason for hiding this comment

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

please explain why we need to have this change, to be more specific, please quote the error in the commit message, and reference the link to RtD.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you, I've made the suggested changes.
Please let me know if I need to add something else.

Copy link
Member

Choose a reason for hiding this comment

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

OK "image to os" I get, but why change away from "latest"? This just sets us up for a stale jump in future

Copy link
Contributor

Choose a reason for hiding this comment

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

@dmick see https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os . so we only have two options: ubuntu-20.04, ubuntu-22.04

probably we could also have referenced it in the commit message, and explain that "ubuntu-22.04" is preferred, as (i guess), presumably, it is newer and hence better, like with newer tool chain and is better supported, etc.

Copy link
Member Author

@VallariAg VallariAg Oct 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@dmick there was some discussion about adding "latest"/"ubuntu-latest-lts" as an option in readthedocs/readthedocs.org#8861
but seems like RtD decided against it because they wanted to avoid breaking users' builds whenever RtD updated "latest" so they're letting users update on their own timeline. Their explanation: readthedocs/readthedocs.org#10401 (comment)

@tchaikov I'll make sure to mention the reason of using a version more explicitly whenever there's next update

tools:
python: "3.7"
python:
version: 3.7
install:
- method: pip
path: .
Expand Down