Update sphinx to 4.4 #33272
Milestone
Comments
|
Branch: u/arojas/update_sphinx_to_4_4 |
|
Commit: |
This comment has been minimized.
This comment has been minimized.
|
Author: Antonio Rojas |
|
comment:3
The changes in |
|
comment:4
Perhaps these substitutions can be made in the |
|
comment:6
Upgrade to sphinx 4.3.1 (#32968) is currently being merged by Volker and will be in the next beta. So this ticket will need rebasing on top of it. And I am surprised you don't seem to need sagemath/sagetrac-mirror@fc84f82 - but looking more closely, all your work with changing external references around may be helping with that. We may need careful navigating around that line. |
|
Branch pushed to git repo; I updated commit sha1. New commits:
|
|
comment:9
Note that these warnings will probably be disabled by default in Sphinx 4.4.1: sphinx-doc/sphinx#10126 |
|
comment:10
Trying this in sage-on-gentoo since sphinx-4.4.0 is now stable. I get |
|
Changed branch from u/arojas/update_sphinx_to_4_4 to u/fbissey/sphinx-4.4 |
|
comment:11
Still building, have trouble with stuff coming from #33309 at the same time on the branch Volker is merging tickets. But that got rid of all those so called warnings that break the build. New commits:
|
|
comment:12
Build failed on pdf with some undefined references. Will try html only to see if that works. |
|
comment:13
Building html only does work. |
|
comment:14
Citations are not relevant in the end I think. From |
|
comment:15
OK, it looks like stuff like |
|
Branch pushed to git repo; I updated commit sha1. New commits:
|
|
comment:17
I am not saying it should be the definitive form, especially in the stuff I changed in the thematic_tutorials, but it now builds both the html and the pdf without a hitch. Pitty I am doing all that remotely, I will have to wait tomorrow to see what it looks like. @kwankyu copying you because you care about the doc so you can give us your opinion about how it looks like after the upgrade and whether we need to improve our output. |
|
Branch pushed to git repo; I updated commit sha1. New commits:
|
|
comment:37
I am fixing the formatting of all the files in the current branch first. Then I'll see if there are any other that lurk around in the rest of sage. |
|
Branch pushed to git repo; I updated commit sha1. New commits:
|
|
comment:39
HTMLs and PDFs build fine on macOS. But updated links need to be checked. I found one error: --- a/src/sage/sat/solvers/satsolver.pyx
+++ b/src/sage/sat/solvers/satsolver.pyx
@@ -316,7 +316,7 @@ def SAT(solver=None, *args, **kwds):
Return a :class:`SatSolver` instance.
Through this class, one can define and solve `SAT
- <https://en.wikipedia.org/wiki/Boolean_satisfiability_problem>`__ problems.
+ <:wikipedia:`Boolean_satisfiability_problem`>`__ problems.
INPUT: |
|
comment:40
Replying to @kwankyu:
It is still a work in progress, I'll get to that one shortly. If you spot some other weird stuff that is not coming from a file touched by this branch, I'd be glad for the report. |
|
comment:41
Replying to @kwankyu:
If I'm not mistaken this has been fixed: |
|
comment:42
No Steve, that format is no good. I have about two more files before getting to that one. |
|
comment:43
Replying to @kiwifb:
OK, I see. |
|
Branch pushed to git repo; I updated commit sha1. New commits:
|
|
comment:45
Done a build (html and pdf), but I won't be able to see the resulting documents before about 9am NZ time which is in a bit less than 13 hours. Of particular interest are
Also I saw |
|
comment:46
Everything looks good in html and pdf. I am putting it for review. |
|
comment:47
Replying to @kiwifb:
It is a role defined in the Python domain. Hence it is defined in Sphinx. See here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html |
|
comment:48
Builds fine and looks fine.
It looks fine.
It looks better. Overall, I am positive on the ticket. We just need to wait for the next beta to resolve merge conflicts. |
|
Reviewer: Kwankyu Lee |
|
comment:50
There shouldn't be any conflict. I am testing this as is in sage-on-gentoo on Volker's merging branch (which includes #33309) and there are no conflicts. If you think a ticket will conflict with this one, I'd like to know about it. |
|
comment:52
Then I set this positive. Reviewers are welcome to add names. |
|
comment:53
Thank you! |
|
Changed branch from u/fbissey/sphinx-4.4 to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Throws warnings (which abort the doc build) when a role can be used but it's not.
CC: @kiwifb @tobihan @collares @kwankyu
Component: packages: standard
Author: Antonio Rojas, François Bissey
Branch/Commit:
17fa6d4Reviewer: Kwankyu Lee
Issue created by migration from https://trac.sagemath.org/ticket/33272
The text was updated successfully, but these errors were encountered: