Skip to content

backport to 2.x fixes for sphinx 1.8? #13258

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.

Sign up for GitHub

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

Jump to bottom
Closed
sandrotosi opened this issue Jan 22, 2019 · 13 comments
Closed

backport to 2.x fixes for sphinx 1.8? #13258

sandrotosi opened this issue Jan 22, 2019 · 13 comments
Milestone
v2.2.4

Comments

@sandrotosi
Copy link
Contributor

Hello,
in Debian we just got this bug report, http://bugs.debian.org/918896:

matplotlib2 fails to build with Sphinx 1.8, currently available in
experimental:

  # build the doc
  [...] /usr/bin/make -C doc html
  make[1]: Entering directory '/<<PKGBUILDDIR>>/doc'
  Running Sphinx v1.8.3

  Warning, treated as error:
  while setting up extension matplotlib.sphinxext.mathmpl: directive u'math' is already registered, it will be overridden
  make[1]: *** [Makefile:20: html] Error 2

This was fixed in matplotlib 3.x in this commit, please backport it:

https://github.com/matplotlib/matplotlib/commit/f87e9f46daf42ad7

That commit switches from generating PNG images for math formulas to MathJax
library, which renders the math formulas on client side. To package it for
Debian, please add this line to conf.py:

  mathjax_path = 'file:///usr/share/javascript/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML'

and make your documentation package depend on libjs-mathjax.

Also upstream has noticed that some math renders incorrectly with MathJax,
there is a follow-up commit which fixes it:

https://github.com/matplotlib/matplotlib/commit/a101de79650e077a

i see an issue was already reported and fixed at #12108 but it looks like the fixes where never backported to 2.x - would it be possible to do that?

thanks!
@NelleV
Copy link
Member

NelleV commented Jan 22, 2019

Sure thing!

@NelleV
Copy link
Member

NelleV commented Jan 22, 2019

I believe it already has been. This patch is fully in our branch already.

@dstansby
Copy link
Member

I'm going to close this since it looks like it's fixed - feel free to comment or re-open if I'm wrong!

@dstansby dstansby added this to the v2.2.4 milestone Jan 24, 2019
@LocutusOfBorg
Copy link

Hello, can we please have a backport against 2.2.x branch?

@tacaswell tacaswell reopened this Feb 1, 2019
@tacaswell
Copy link
Member

It looks like this got pulled back to 3.0.x and 3.0.0-doc, but not the 2.2.x branches.

I think we need to backport both #12149 and #11928

@tacaswell
Copy link
Member

Tried to do this naively, did not work, do not have time to dig deeper now.

@tacaswell tacaswell mentioned this issue Feb 12, 2019
Merged
@tacaswell
Copy link
Member

Closed by #13420

@LocutusOfBorg
Copy link

thanks! I will test it in a few minutes

@sandrotosi
Copy link
Contributor Author

@LocutusOfBorg i'm already working on it, please leave the package maintainer job to the package maintainer

@LocutusOfBorg
Copy link

@sandrotosi I'll leave happily to you the Debian part :)
I want to take care of the Ubuntu part, and Ubuntu is going to freeze really soon and matplotlib2 never reached any stable Ubuntu release.

@LocutusOfBorg
Copy link

(btw without manual intervention the package won't probably be ever autosyncd, because it has been removed from Ubuntu due to sphinx 1.8)

@sandrotosi
Copy link
Contributor Author

the PR patch (applied directly on top of 2.2.3) works, thanks!

@tacaswell
Copy link
Member

There should be a 2.2.4 in the next few days as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.2.4
Development

No branches or pull requests
5 participants
@NelleV @tacaswell @sandrotosi @LocutusOfBorg @dstansby