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

Sphinx/docutils update for Sage 9.4 #31696

Closed
mkoeppe opened this issue Apr 19, 2021 · 29 comments
Closed

Sphinx/docutils update for Sage 9.4 #31696

mkoeppe opened this issue Apr 19, 2021 · 29 comments

Comments

@mkoeppe
Copy link
Contributor

mkoeppe commented Apr 19, 2021

We are at 3.1.2, current is 4.0.1

https://repology.org/projects/p/?inrepo=sagemath

Depends on #30551

CC: @kiwifb @antonio-rojas @jhpalmieri @slel

Component: packages: standard

Author: Antonio Rojas

Branch/Commit: bc84af8

Reviewer: John Palmieri

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

@mkoeppe mkoeppe added this to the sage-9.4 milestone Apr 19, 2021
@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 19, 2021

Dependencies: #30551

@mkoeppe mkoeppe changed the title Sphinx update for Sage 9.4 Sphinx/docutils update for Sage 9.4 Apr 19, 2021
@antonio-rojas
Copy link
Contributor

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 10, 2021

Commit: ad51564

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 10, 2021

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

c8272c0Sync autodoc with upstream to fix deprecation warnings
1ed5bd7Remove duplicate modules, which throw a warning with sphinx 4
ad51564Upgrade sphinx to 4.0.0

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 10, 2021

Changed commit from ad51564 to b9e390f

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 10, 2021

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

b9e390fUpgrade sphinx to 4.0.1

@antonio-rojas
Copy link
Contributor

comment:5

Pushed the sphinx 4 update, with the usual batch of deprecation fixes. We should really try to get rid of the custom autodoc fork, most of the breakage comes from it getting out of sync with upstream.

@antonio-rojas

This comment has been minimized.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 11, 2021

Changed commit from b9e390f to d5a374a

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 11, 2021

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

d5a374aClear LANGUAGE too

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 11, 2021

Changed commit from d5a374a to 285ea99

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 11, 2021

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

285ea99Update test for different sphinx output

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 5, 2021

Changed commit from 285ea99 to 5bf10dd

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 5, 2021

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

e74c40fMerge branch 'develop' of https://github.com/sagemath/sage into t/31696/sphinx_docutils_update_for_sage_9_4
5bf10ddUpdate docutils to 0.17.1

@kiwifb
Copy link
Member

kiwifb commented Jun 5, 2021

comment:10

Replying to @antonio-rojas:

Pushed the sphinx 4 update, with the usual batch of deprecation fixes. We should really try to get rid of the custom autodoc fork, most of the breakage comes from it getting out of sync with upstream.

For the custom autodoc fork, we should just open a ticket and see what needs fixing when we remove it. May be not for 9.4, but we need to work on this.

@jhpalmieri
Copy link
Member

comment:11

Building the documentation fails for me with WARNING: rST localisation for language "hu" not found.

@jhpalmieri
Copy link
Member

comment:12

Replying to @kiwifb:

Replying to @antonio-rojas:

Pushed the sphinx 4 update, with the usual batch of deprecation fixes. We should really try to get rid of the custom autodoc fork, most of the breakage comes from it getting out of sync with upstream.

For the custom autodoc fork, we should just open a ticket and see what needs fixing when we remove it. May be not for 9.4, but we need to work on this.

How about #30893?

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 12, 2021

Changed commit from 5bf10dd to 5272520

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 12, 2021

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

5272520Ignore warnings from docutils about missing rST localisation

@jhpalmieri
Copy link
Member

comment:14

Thank you, that fixes the html build problems. The PDF documentation doesn't build though: the Japanese documents fail with


! Class jsbook Error: You are running upLaTeX.
(jsbook)              Please use pLaTeX instead, or add 'uplatex' to
(jsbook)              the class option list.

See the jsbook class documentation for explanation.
Type  H <return>  for immediate help.
 ...                                              
                                                  
l.229       {\@ehc}
                   
? 
! Emergency stop.
 ...                                              
                                                  
l.229       {\@ehc}

@antonio-rojas
Copy link
Contributor

comment:15

Looks like sphinx-doc/sphinx@1d9eeed

Anyway, this is where I give up. I never build PDF docs myself so I'm not really motivated to keep digging into this.

@jhpalmieri
Copy link
Member

@jhpalmieri
Copy link
Member

Changed commit from 5272520 to bc84af8

@jhpalmieri
Copy link
Member

Author: Antonio Rojas

@jhpalmieri
Copy link
Member

comment:17

This works for me. Please test. I am happy to positively review everything but my own contribution.


New commits:

bc84af8trac 31696: fixes for Japanese documentation, PDF build

@jhpalmieri
Copy link
Member

Reviewer: John Palmieri

@jhpalmieri
Copy link
Member

comment:18

In fact I don't think all of my changes were necessary, but we don't need to include stuff about the French documentation in doc/ja/....

@antonio-rojas
Copy link
Contributor

comment:19

PDF build works for me, setting to positive review as per comment:17

@vbraun
Copy link
Member

vbraun commented Jun 29, 2021

Changed branch from u/jhpalmieri/sphinx_docutils_update_for_sage_9_4 to bc84af8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants