Update sphinx to 4.4 - Githubissues

antonio-rojas commented 2 years ago

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: 17fa6d4

Reviewer: Kwankyu Lee

Issue created by migration from https://trac.sagemath.org/ticket/33272

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Changed commit from 7d373f0 to 7c27669

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

7c27669 fix formatting in installation doc

kwankyu commented 2 years ago

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:

kiwifb commented 2 years ago

comment:40

Replying to @kwankyu:

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:

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.

strogdon commented 2 years ago

comment:41

Replying to @kwankyu:

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:

If I'm not mistaken this has been fixed:

https://github.com/sagemath/sagetrac-mirror/blob/7c2766973cc44e071270af061c80391c8fa80116/src/sage/sat/solvers/satsolver.pyx&id2=15c8011dd0b21c74f698b05ed2608f7afbec0d1a

kiwifb commented 2 years ago

comment:42

No Steve, that format is no good. I have about two more files before getting to that one.

strogdon commented 2 years ago

comment:43

Replying to @kiwifb:

No Steve, that format is no good. I have about two more files before getting to that one.

OK, I see.

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

17fa6d4 fix the format of all remaining extlinks already touched on the branch.

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 2 years ago

Changed commit from 7c27669 to 17fa6d4

kiwifb commented 2 years ago

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

src/sage/knots/knotinfo.py where the original was missing an ending " and I am not sure if it will parse properly or need to be replaced by codes.
src/sage/sat/solvers/satsolver.pyx where I changed slightly the caption.

Also I saw :meth: in src/sage/knots/knotinfo.py and several other files but I cannot find where it is defined. Can someone tell me more about it?

kiwifb commented 2 years ago

comment:46

Everything looks good in html and pdf. I am putting it for review.

kwankyu commented 2 years ago

comment:47

Replying to @kiwifb:

Also I saw :meth: in src/sage/knots/knotinfo.py and several other files but I cannot find where it is defined. Can someone tell me more about it?

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

kwankyu commented 2 years ago

comment:48

Builds fine and looks fine.

Of particular interest are

src/sage/knots/knotinfo.py where the original was missing an ending " and I am not sure if it will parse properly or need to be replaced by codes.

It looks fine.

src/sage/sat/solvers/satsolver.pyx where I changed slightly the caption.

It looks better.

Overall, I am positive on the ticket. We just need to wait for the next beta to resolve merge conflicts.

kwankyu commented 2 years ago

Reviewer: Kwankyu Lee

kiwifb commented 2 years ago

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.

kwankyu commented 2 years ago

comment:51

Replying to @kiwifb:

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.

You are right. I was mistaken.

kwankyu commented 2 years ago

comment:52

Then I set this positive. Reviewers are welcome to add names.

kiwifb commented 2 years ago

comment:53

Thank you!

vbraun commented 2 years ago

Changed branch from u/fbissey/sphinx-4.4 to 17fa6d4

sagemath / sage

Update sphinx to 4.4 #33272