Upgrade to Sphinx 1.8.5

[saraedum]

This ticket upgrades Sphinx to version 1.8.5.

Our previous upgrade was to Sphinx 1.7.6 in #26033.

Tarball: https://files.pythonhosted.org/packages/2a/86/8e1e8400bb6eca5ed960917952600fce90599e1cb0d20ddedd81ba163370/Sphinx-1.8.5.tar.gz

Depends on #27528

CC: @timokau @kiwifb @antonio-rojas @embray @slel @jhpalmieri @dimpase @tobihan

Component: packages: standard

Keywords: sphinx, conda, upgrade

Author: Julian Rüth, Jeroen Demeyer, John Palmieri, Tobias Hansen

Branch/Commit: f1a08e3

Reviewer: Dima Pasechnik

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

[saraedum]

comment:1

Note that there is nothing I can doctest here.

[saraedum]

Branch: u/saraedum/26451

[saraedum]

Work Issues: is the patchbot happy?

[saraedum]

Commit: eb00e75

[saraedum]

New commits:

eb00e75

Call Sphinx() 1.8 constructor

[saraedum]

Changed keywords from none to sphinx, conda

[jdemeyer]

comment:6

I'd rather upgrade Sphinx while we're at it. That's a good thing to do and I would need to do that anyway to test this ticket.

[saraedum]

comment:7

I was fearing that you would propose that ;)

I am not planning on working on upgrading Sphinx in Sage (as I've got too many other things to worry about.) I don't know what has chahnged in 1.8.1 and whether we would want to upgrade at all.

More generally, I don't know what we're aiming for here. I feel we don't have enough people to keep Sage-the-distribution close to upstream most of the time so that's probably not what we should be aiming for?

That said, feel free to upgrade Sphinx :) But if anybody likes these small changes and we want to move the Sphinx upgrade into a separate ticket, I would prefer that.

[antonio-rojas]

comment:9

Upgrading sphinx requires further changes to make docs build. I have a minimal patch at https://git.archlinux.org/svntogit/community.git/tree/trunk/sagemath-doc-sphinx-1.8.patch?h=packages/sagemath-doc
to make it build, although with it one still gets lots of deprecation warnings due to changes in logging functions.

[jdemeyer]

comment:11

Antonio, does Sphinx 1.8.1 work with just those changes (even if there are deprecation warnings)? If so, we might as well upgrade.

[antonio-rojas]

comment:12

Replying to @jdemeyer:

Antonio, does Sphinx 1.8.1 work with just those changes (even if there are deprecation warnings)? If so, we might as well upgrade.

Yes, with Julian's patch and mine introspection works and docs build correctly.

[jdemeyer]

Changed work issues from is the patchbot happy? to none

[jdemeyer]

Changed author from Julian Rüth to Julian Rüth, Jeroen Demeyer

[saraedum]

comment:14

jdemeyer, did you forget to push your branch? (you added yourself as an Author but did not push any changes it seems.)

[jdemeyer]

comment:15

Please give me time...

[saraedum]

comment:16

Note that there is a licensing issue in sphinxify.py, see #26453.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

48b7acd	trac 27528: remove some patches for Sphinx and pygments.
b23b8cc	trac 27528: use a custom Sphinx transform to handle
687b338	trac 27528: clean up some code-blocks in the reST documentation.
e1794bb	trac 26451: upgrade to Sphinx 1.8.5.
c61a041	trac 26451: Call Sphinx() 1.8 constructor
5e32410	trac 26451: change 'app.builder.info' to 'logger.info'.
0a92d48	trac 26451: inventory builder: remove _static directory upon cleanup,

[jhpalmieri]

comment:125

Here is a new branch which is based on #27528. I put the <BLANKLINE> stuff at #27528, not here, since I needed it there.

[embray]

comment:127

Ticket retargeted after milestone closed (if you don't believe this ticket is appropriate for the Sage 8.8 release please retarget manually)

[sagetrac-git]

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

737afd8

trac 26451: fix one doctest

[sagetrac-git]

Changed commit from 0a92d48 to 737afd8

[jhpalmieri]

comment:130

PDF documentation builds fine for me.

[dimpase]

comment:131

looks good to me.

[jhpalmieri]

comment:132

Great! Now we need to silence all of the stupid deprecation warnings.

[jhpalmieri]

comment:133

See #27578 for a ticket to stop using the deprecated formatargspec.

[vbraun]

comment:134

Merge conflict

[sagetrac-git]

Changed commit from 737afd8 to f1a08e3

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

a55438e	trac 26451: upgrade to Sphinx 1.8.5.
827ff80	trac 26451: Call Sphinx() 1.8 constructor
22736d7	trac 26451: change 'app.builder.info' to 'logger.info'.
4cab150	trac 26451: inventory builder: remove _static directory upon cleanup,
f1a08e3	trac 26451: fix one doctest

[jhpalmieri]

comment:136

Rebased.

[vbraun]

Changed branch from u/jhpalmieri/26451 to f1a08e3