Pinning needed to build docs with Python 3.10 or newer#13587
Pinning needed to build docs with Python 3.10 or newer#13587eerovaher wants to merge 3 commits intoastropy:mainfrom
Conversation
|
"Allowed failure" failure is unrelated. Waiting on RTD. |
|
Does this really need backporting? Do we really need to build release branches docs with Python 3.10 ? 💭 |
|
I added the backport labels because the last commits that edited the |
|
I am a little afraid reducing the pinned version will wreck havoc in LTS. And if we can resolve the real problem before v5.2 and backport that instead, then backport of this is irrelevant. @saimn , what do you think? |
pllim
left a comment
There was a problem hiding this comment.
Let's not backport for now. We can always backport if there is a real need. Thanks!
|
Can you pls rebase and see if CI will be green? Thanks! |
The previous filename is deprecated (https://docs.readthedocs.io/en/stable/config-file/index.html).
Ubuntu and Python versions used by `readthedocs` are updated. Python 3.10 is incompatible with `sphinx` 3.5, so its latest allowed version had to be bumped down even further. [ci skip]
b152590 to
d6a56cc
Compare
|
Looks like maybe this warning is failing the build. Not sure where it is coming from. |
The pin should be removed when `sphinx` is unpinned. [ci skip]
|
sphinx-doc/sphinx#9841 (comment) recommends that we either upgrade |
| docs = | ||
| sphinx<4 | ||
| sphinx<3.5 | ||
| docutils<0.18 # This should be removed when `sphinx` is unpinned, #11725 |
There was a problem hiding this comment.
Does the indentation mean anything?
|
I think Tom R and Stuart M are concerned about the pinning. Lemme ping them for review. |
|
Is there any need to update RTD to use Python 3.10? (It works fine with 3.9, right?) Why not wait until we have fixed compatibility with Sphinx 4? |
|
It was a good idea to open this pull request so that we would know for sure what it takes to build the documentation on Python 3.10 without any warnings. But because it turns out that we would have to pin two packages I would tend to agree that merging this pull request is not worth it. @pllim, you suggested opening this pull request, so if you agree with what has been said then feel free to close it. |
Read the Docs build system|
OK, closing then. Thanks for the work anyway, @eerovaher ! Now, anyone who wants to build doc in Python 3.10 will know what it takes. 😃 |
Description
Ubuntu and Python versions used by
Read the Docsare updated. Python 3.10 is incompatible withsphinx3.5, so its latest allowed version had to be bumped down even further.See #11725 (comment) and the preceding comments for more context.
Checklist for package maintainer(s)
This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.
Extra CIlabel.no-changelog-entry-neededlabel. If this is a manual backport, use theskip-changelog-checkslabel unless special changelog handling is necessary.astropy-botcheck might be missing; do not let the green checkmark fool you.backport-X.Y.xlabel(s) before merge.