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.

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

Preparation for Sphinx 7 #37334

Merged
merged 11 commits into from
Feb 25, 2024
Merged

Preparation for Sphinx 7 #37334

merged 11 commits into from
Feb 25, 2024

Conversation

kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Feb 14, 2024

Based on #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!

📝 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 changed the title p/37129/sphinx 7 Accommodate Sphinx 7 to sage documentation Feb 14, 2024
@kwankyu kwankyu changed the title Accommodate Sphinx 7 to sage documentation Accommodate Sage for Sphinx 7 Feb 14, 2024
@kwankyu kwankyu changed the title Accommodate Sage for Sphinx 7 Prepare for Sphinx 7 Feb 14, 2024
@kwankyu kwankyu changed the title Prepare for Sphinx 7 Preparation for Sphinx 7 Feb 14, 2024
@kwankyu kwankyu marked this pull request as ready for review February 14, 2024 22:57
@mkoeppe
Copy link
Contributor

mkoeppe commented Feb 15, 2024

Can the upgrade #37129 be merged without the changes here?
If not, please feel free to just rebase on the current version of #37129, and I can close #37129

@kwankyu
Copy link
Collaborator Author

kwankyu commented Feb 15, 2024

Can the upgrade #37129 be merged without the changes here?

Yes. But this PR should also be merged before release, of course.

For this PR, we should wait and check the built documentation. I hope that the clogged ci would soon be resolved...

Copy link

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

@kwankyu
Copy link
Collaborator Author

kwankyu commented Feb 16, 2024

I looked over the generated doc. I see no significant changes. Looks good to me.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Feb 17, 2024

To keep our beta a little more stable, this PR is better to be merged together with #37129.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Feb 17, 2024

I found one nontrivial small change

 <section id="id2">
-<h2>Sageで力まかせに計算<a class="headerlink" href="#id2" title="この見出しへのパーマリンク">#</a></h2>
+<h2>Sageで力まかせに計算<a class="headerlink" href="#id2" title="Link to this heading">#</a></h2>
 <p>まず要素値が乱数で与えられる <span class="math notranslate nohighlight">\(500 \times 500\)</span> 行列を作っておく.</p>

There may be other small changes perhaps due to Sphinx 7. In my opinion, these can be investigated later.

@mkoeppe
Copy link
Contributor

mkoeppe commented Feb 17, 2024

Let's merge it. I also looked at the diff a bit and at the formatting of some chapters. All good.

@kwankyu
Copy link
Collaborator Author

kwankyu commented Feb 17, 2024

Thanks!

vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 19, 2024
    
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 vbraun merged commit 0f35a69 into sagemath:develop Feb 25, 2024
14 of 40 checks passed
@mkoeppe mkoeppe added this to the sage-10.3 milestone Mar 7, 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