Skip to content

Sphinx 7#37129

Merged
vbraun merged 3 commits intosagemath:developfrom
mkoeppe:sphinx_7
Feb 25, 2024
Merged

Sphinx 7#37129
vbraun merged 3 commits intosagemath:developfrom
mkoeppe:sphinx_7

Conversation

@mkoeppe
Copy link
Copy Markdown
Contributor

@mkoeppe mkoeppe commented Jan 21, 2024

We update Sphinx from 5.x to 7.x, including updates to various dependencies to latest, and update furo to 2023.9.10

Reducing the complexity of the distribution by switching the packages from normal packages to wheel packages.

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • 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 accordingly.

⌛ Dependencies

@kwankyu kwankyu mentioned this pull request Feb 14, 2024
5 tasks
@kwankyu
Copy link
Copy Markdown
Collaborator

kwankyu commented Feb 14, 2024

imagesize fails to install because of the presence of spkg-install.in.

@kwankyu
Copy link
Copy Markdown
Collaborator

kwankyu commented Feb 14, 2024

Here

https://deploy-livedoc--sagemath.netlify.app/html/en/developer/packaging#:~:text=If%20not%2C%20then%20if%20there%20is%20a%20checksums.ini%20file%2C%20it%20is%20normal%20or%20wheel

I think you can differentiate between normal package and wheel package based on the presence or absence of spkg-install.in (or spkg-install).

@mkoeppe
Copy link
Copy Markdown
Contributor Author

mkoeppe commented Feb 15, 2024

I think you can differentiate between normal package and wheel package based on the presence or absence of spkg-install.in (or spkg-install).

I've made an edit in a similar direction in #37352

Copy link
Copy Markdown
Collaborator

@kwankyu kwankyu left a comment

Choose a reason for hiding this comment

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

This works well on my system. I was just waiting for B&T to be sure. But our CI seems too much clogged at present.

@mkoeppe
Copy link
Copy Markdown
Contributor Author

mkoeppe commented Feb 15, 2024

Thank you!

@github-actions
Copy link
Copy Markdown

Documentation preview for this PR (built with commit 69209b8; changes) is ready! 🎉

vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 18, 2024
sagemathgh-37129: Sphinx 7
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

We update Sphinx from 5.x to 7.x, including updates to various
dependencies to latest, and update furo to 2023.9.10

Reducing the complexity of the distribution by switching the packages
from normal packages to wheel packages.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [ ] 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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->
- Depends on sagemath#37222

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37129
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee
vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 18, 2024
sagemathgh-37352: `sage --package create`: When re-creating with a different source type, clean up
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
For example, when switching from a `pip` package to `wheel` package,
remove the `requirements.txt` file.
When switching from `normal` to `wheel`, remove the `spkg-install.in`
file.

One of these cases was handled by a commit on sagemath#36641, cherry-picked from
there.
Generalizing here to avoid mistakes such as
sagemath#37129 (comment) in
the future.

Example:
```
$ ./sage -package create imagesize --pypi
Downloading tarball from https://pypi.io/packages/py2.py3/i/imagesize/im
agesize-1.4.1-py2.py3-none-any.whl to /Users/mkoeppe/s/sage/sage-
rebasing/worktree-pristine/upstream/imagesize-1.4.1-py2.py3-none-any.whl
[......................................................................]
$ git status
On branch sage_package_create_remove_files
Your branch is ahead of 'upstream/develop' by 3 commits.
  (use "git push" to publish your local commits)

Changes not staged for commit:
  (use "git add/rm <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   build/pkgs/imagesize/SPKG.rst
        modified:   build/pkgs/imagesize/checksums.ini
        modified:   build/pkgs/imagesize/install-requires.txt
        deleted:    build/pkgs/imagesize/spkg-install.in
        modified:   build/pkgs/imagesize/type
```

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37352
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee, Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 19, 2024
sagemathgh-37129: Sphinx 7
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

We update Sphinx from 5.x to 7.x, including updates to various
dependencies to latest, and update furo to 2023.9.10

Reducing the complexity of the distribution by switching the packages
from normal packages to wheel packages.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [ ] 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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->
- Depends on sagemath#37222

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37129
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee
vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 19, 2024
sagemathgh-37334: Preparation for Sphinx 7
    
Based on sagemath#37129, we adjust sage for Sphinx 7. Mainly,

- (once again) `sage_autodoc` is updated based on the source file of
Sphinx 7.

Before the arrival of Sphinx 8, hopefully, we should remove
`sage_autodoc`!

<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

- sagemath#37129

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37334
Reported by: Kwankyu Lee
Reviewer(s):
vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 19, 2024
sagemathgh-37352: `sage --package create`: When re-creating with a different source type, clean up
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
For example, when switching from a `pip` package to `wheel` package,
remove the `requirements.txt` file.
When switching from `normal` to `wheel`, remove the `spkg-install.in`
file.

One of these cases was handled by a commit on sagemath#36641, cherry-picked from
there.
Generalizing here to avoid mistakes such as
sagemath#37129 (comment) in
the future.

Example:
```
$ ./sage -package create imagesize --pypi
Downloading tarball from https://pypi.io/packages/py2.py3/i/imagesize/im
agesize-1.4.1-py2.py3-none-any.whl to /Users/mkoeppe/s/sage/sage-
rebasing/worktree-pristine/upstream/imagesize-1.4.1-py2.py3-none-any.whl
[......................................................................]
$ git status
On branch sage_package_create_remove_files
Your branch is ahead of 'upstream/develop' by 3 commits.
  (use "git push" to publish your local commits)

Changes not staged for commit:
  (use "git add/rm <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   build/pkgs/imagesize/SPKG.rst
        modified:   build/pkgs/imagesize/checksums.ini
        modified:   build/pkgs/imagesize/install-requires.txt
        deleted:    build/pkgs/imagesize/spkg-install.in
        modified:   build/pkgs/imagesize/type
```

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37352
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee, Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 22, 2024
sagemathgh-37334: Preparation for Sphinx 7
    
Based on sagemath#37129, we adjust sage for Sphinx 7. Mainly,

- (once again) `sage_autodoc` is updated based on the source file of
Sphinx 7.

Before the arrival of Sphinx 8, hopefully, we should remove
`sage_autodoc`!

<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

- sagemath#37129

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37334
Reported by: Kwankyu Lee
Reviewer(s):
vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 22, 2024
sagemathgh-37352: `sage --package create`: When re-creating with a different source type, clean up
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
For example, when switching from a `pip` package to `wheel` package,
remove the `requirements.txt` file.
When switching from `normal` to `wheel`, remove the `spkg-install.in`
file.

One of these cases was handled by a commit on sagemath#36641, cherry-picked from
there.
Generalizing here to avoid mistakes such as
sagemath#37129 (comment) in
the future.

Example:
```
$ ./sage -package create imagesize --pypi
Downloading tarball from https://pypi.io/packages/py2.py3/i/imagesize/im
agesize-1.4.1-py2.py3-none-any.whl to /Users/mkoeppe/s/sage/sage-
rebasing/worktree-pristine/upstream/imagesize-1.4.1-py2.py3-none-any.whl
[......................................................................]
$ git status
On branch sage_package_create_remove_files
Your branch is ahead of 'upstream/develop' by 3 commits.
  (use "git push" to publish your local commits)

Changes not staged for commit:
  (use "git add/rm <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   build/pkgs/imagesize/SPKG.rst
        modified:   build/pkgs/imagesize/checksums.ini
        modified:   build/pkgs/imagesize/install-requires.txt
        deleted:    build/pkgs/imagesize/spkg-install.in
        modified:   build/pkgs/imagesize/type
```

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37352
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee, Matthias Köppe
@vbraun vbraun merged commit bdf8f97 into sagemath:develop Feb 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants