Prepare sage for sphinx 8 #38549
Merged
Prepare sage for sphinx 8 #38549
+77
−115
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mum supported sphinx version to 7.4.7
5 tasks
|
Working well, thanks! |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Aug 27, 2024
This PR prepares sage for sphinx 8. An update for sage_autodoc.py is
needed and is provided in this PR.
The minimum known version of sphinx supporting the updated
sage_autodoc.py is 7.4.7. So, sphinx is updated from 7.3.7 (which is
known not to work) to 7.4.7.
### 📝 Checklist
<!-- Put an `x` in all the boxes that apply. -->
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.
URL: sagemath#38549
Reported by: François Bissey
Reviewer(s):
|
@kiwifb This has broken Python 3.9 compatibility: |
|
OK, that came up before, how far do we go in python support? |
|
3.9 is oldest supported |
|
#37006 will drop 3.9, but that's likely Sage 10.6 territory |
|
Looking back at sphinx 8, from which I based the work on, they have dropped support for py3.9 https://github.com/sphinx-doc/sphinx/blob/04381789db7466d56d9eb29d23d979fc16604acc/pyproject.toml#L16 |
Yes, that's why I have the Sphinx 8 upgrade in #37006 |
5 tasks
|
OK #38619 is ready for you to test, I hope that's the only change back that is needed but I cannot test it myself. |
5 tasks
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 8, 2024
This PR corrects the fact the sage_autodoc.py changes needed for sphinx 8 dropped python 3.9 support. This is a consequence of the fact that sphinx 8 has dropped python 3.9. Since we still want to support python 3.9, some support has to be re- introduced. See sagemath#38549 (comment) and after. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. URL: sagemath#38619 Reported by: François Bissey Reviewer(s):
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 8, 2024
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> The version constraint added in sagemath#38549 broke the conda ci workflow and added an unnecessarily strict version constraint for sphinx as a dependency of sagelib (as opposed to sage-the-docs). This is fixed by providing the old version constraint for sphinx in `setup.cfg`, but with `v8` now allowed. Alternatively, the stricter version constraint should only be added to the sage-the-docs package. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38627 Reported by: Tobias Diez Reviewer(s): François Bissey
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 8, 2024
This PR corrects the fact the sage_autodoc.py changes needed for sphinx 8 dropped python 3.9 support. This is a consequence of the fact that sphinx 8 has dropped python 3.9. Since we still want to support python 3.9, some support has to be re- introduced. See sagemath#38549 (comment) and after. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. URL: sagemath#38619 Reported by: François Bissey Reviewer(s):
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 8, 2024
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> The version constraint added in sagemath#38549 broke the conda ci workflow and added an unnecessarily strict version constraint for sphinx as a dependency of sagelib (as opposed to sage-the-docs). This is fixed by providing the old version constraint for sphinx in `setup.cfg`, but with `v8` now allowed. Alternatively, the stricter version constraint should only be added to the sage-the-docs package. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38627 Reported by: Tobias Diez Reviewer(s): François Bissey
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 10, 2024
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> The version constraint added in sagemath#38549 broke the conda ci workflow and added an unnecessarily strict version constraint for sphinx as a dependency of sagelib (as opposed to sage-the-docs). This is fixed by providing the old version constraint for sphinx in `setup.cfg`, but with `v8` now allowed. Alternatively, the stricter version constraint should only be added to the sage-the-docs package. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38627 Reported by: Tobias Diez Reviewer(s): François Bissey
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 12, 2024
This PR corrects the fact the sage_autodoc.py changes needed for sphinx 8 dropped python 3.9 support. This is a consequence of the fact that sphinx 8 has dropped python 3.9. Since we still want to support python 3.9, some support has to be re- introduced. See sagemath#38549 (comment) and after. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. URL: sagemath#38619 Reported by: François Bissey Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 12, 2024
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> The version constraint added in sagemath#38549 broke the conda ci workflow and added an unnecessarily strict version constraint for sphinx as a dependency of sagelib (as opposed to sage-the-docs). This is fixed by providing the old version constraint for sphinx in `setup.cfg`, but with `v8` now allowed. Alternatively, the stricter version constraint should only be added to the sage-the-docs package. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38627 Reported by: Tobias Diez Reviewer(s): François Bissey
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 14, 2024
This PR corrects the fact the sage_autodoc.py changes needed for sphinx 8 dropped python 3.9 support. This is a consequence of the fact that sphinx 8 has dropped python 3.9. Since we still want to support python 3.9, some support has to be re- introduced. See sagemath#38549 (comment) and after. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. URL: sagemath#38619 Reported by: François Bissey Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Sep 14, 2024
<!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> The version constraint added in sagemath#38549 broke the conda ci workflow and added an unnecessarily strict version constraint for sphinx as a dependency of sagelib (as opposed to sage-the-docs). This is fixed by providing the old version constraint for sphinx in `setup.cfg`, but with `v8` now allowed. Alternatively, the stricter version constraint should only be added to the sage-the-docs package. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#38627 Reported by: Tobias Diez Reviewer(s): François Bissey
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR prepares sage for sphinx 8. An update for sage_autodoc.py is needed and is provided in this PR.
The minimum known version of sphinx supporting the updated sage_autodoc.py is 7.4.7. So, sphinx is updated from 7.3.7 (which is known not to work) to 7.4.7.
📝 Checklist