-
Notifications
You must be signed in to change notification settings - Fork 12
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
Updating .readthedocs.yml
with Python3.11
#89
Conversation
.readthedocs.yml
with Python3.8
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #89 +/- ##
=======================================
Coverage 94.45% 94.45%
=======================================
Files 8 8
Lines 1443 1443
=======================================
Hits 1363 1363
Misses 80 80
☔ View full report in Codecov by Sentry. |
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.
Default python version for readthedocs is 3.11. 3.8 is going end of life next year. Let's just build the docs using 3.11 instead? It's also faster -- which I think is better for everyone.
Also -- we probably should be testing the package on 3.11, besides just the currently broken dev only dependencies. And we should probably start testing on 3.12 as well. These could be handled in a separate PR.
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.
in addition to bumping RTD to 3.11, can we also update this to 3.8
https://github.com/spacetelescope/astrocut/blob/main/astrocut/__init__.py#L13
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.
assuming docs are building, looks good to me
.readthedocs.yml
with Python3.8.readthedocs.yml
with Python3.11
The Astrocut RTD maintainers received an e-mail notification about adding a
.readthedocs.yml
v2 configuration file to our project, as they will no longer be supporting projects with implicit dependencies. More info can be found in this article: https://blog.readthedocs.com/migrate-configuration-v2/ .@ceb8 already built us a
.readthedocs.yml
v2 file, so we are good to go. The reason we actually got that e-mail was because we had the following checkbox checked off in theAdvanced Settings
of theAstrocut
project, which is the feature that will be deprecated in September 2023:All it needed was to be updated to require python 3.8 instead of 3.7, because 3.7 does not jive with
astropy>=5.2
, which caused our documentation to break for the past 4 months, and is the actual reason for this PR:TLDR; This PR updates the
.readthedocs.yml
to build documentation on python3.8
(as opposed to the original3.7
), because our minimumastropy
requirement of>=5.2
doesn't work withpy37
. This PR also updates the minimum python version requested in thesetup.cfg
.