System package information and spkg-configure for mathjax

[mkoeppe]

After #31035, our mathjax spkg is only used in our sphinx documentation. We currently ship a "stripped" version of mathjax 2.7.4 (see build/pkgs/mathjax/spkg-src; #25032, #18596); #25833 proposes an upgrade to 3.x.

We add an spkg-configure.m4 script for the standard package mathjax, as well as corresponding system package information in build/pkgs/mathjax/distros/ using https://repology.org/projects/?search=mathjax

---

Random references:

py-mathjax/pypi/py-mathjax at master · kiwi0fruit/py-mathjax
https://github.com/kiwi0fruit/py-mathjax/tree/master/pypi/py-mathjax

Debian JavaScript Maintainers / mathjax · GitLab
https://salsa.debian.org/js-team/mathjax

sphinx/setup.py at 3.x · sphinx-doc/sphinx
https://github.com/sphinx-doc/sphinx/blob/3.x/setup.py

Math support for HTML outputs in Sphinx — Sphinx 4.0.0+ documentation
https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.mathjax

sphinx-ext-mathjax - Google Search
https://www.google.com/search?safe=off&sxsrf=ALeKk03spVlQ9ALPLJJCbNfF9EIdC_LYuQ%3A1596929073175&ei=MTQvX8mUCuKU0PEPu-yOiAE&q=sphinx-ext-mathjax&oq=sphinx-ext-mathjax&gs_lcp=CgZwc3ktYWIQAzIFCAAQzQIyBQgAEM0CMggIABDNAhCLAzIICAAQzQIQiwMyCAgAEM0CEIsDOgQIABBHOgcIIxCwAhAnOgcIIRAKEKABOgUIIRCgAToFCCEQqwJQmyhY4UVgtFBoAHABeACAAWqIAeUHkgEDOS4ymAEAoAEBqgEHZ3dzLXdpergBA8ABAQ&sclient=psy-ab&ved=0ahUKEwiJ8Yyx4IzrAhViCjQIHTu2AxEQ4dUDCAw&uact=5

Math support for HTML outputs in Sphinx — Sphinx 4.0.0+ documentation
https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.mathjax

sphinx/mathjax.py at 3.x · sphinx-doc/sphinx
https://github.com/sphinx-doc/sphinx/blob/3.x/sphinx/ext/mathjax.py

CC: @jcamp0x2a @paulmasson @slel @egourgoulhon @orlitzky @kwankyu @jhpalmieri @nthiery @enriqueartal @kiwifb @antonio-rojas @tobihan @Etn40ff @tobiasdiez

Component: packages: standard

Keywords: mathjax, sd111

Author: Samuel Lelièvre, ...

Branch/Commit: public/30296 @ 5c624ab

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

[mkoeppe]

comment:2

There are numerous unresolved tickets regarding mathjax...

• System package information and spkg-configure for mathjax #30296
• Allow LaTeX in text3d #30226
• Prevent JSmol from phoning home #30030
• #29993 comment:9
• Remove hardcoded mathjax path in docs/conf.py #28547
• MathJax causing unusual hanging in large notebooks #28257
• Remove bad mathjax symlink and bad mathjax directories #26612
• Upgrade to MathJax 3 and configure Sage #25833
• Meta-ticket: Update other packages to using the sage-dist-helpers functions + DESTDIR where applicable #24024
• Confusing documentation on MathJax in light of use in Jupyter notebook #24367
• Improve introspection capabilities of Sage Jupyter Kernel #25015
• In the built documentation, replace duplicate files by symlinks #25111
• MathJax javascript loaded more than once #22394
• Don't strip MathJax fonts #18596

[mkoeppe]

comment:4

For availability of mathjax in distributions, see https://repology.org/project/mathjax/versions

[mkoeppe]

Branch: u/mkoeppe/system_package_information_and_spkg_configure_for_mathjax

[mkoeppe]

comment:6

The commit only indicates where the system directory should be inserted.

I don't plan to work on this ticket.

Hoping that people knowledgeable about the Jupyter notebook and/or documentation building will be interesting in working on it.

---

New commits:

68a0dda

build/pkgs/sage_conf/src/sage_conf.py.in: Add MATHJAX_DIR

[mkoeppe]

Commit: 68a0dda

[mkoeppe]

comment:7

There is also a pip-installable package https://pypi.org/project/py-mathjax/, but I think using it has not benefits for us.

[mkoeppe]

comment:8

Also notebook bundles mathjax ... why do we install another copy?

[jhpalmieri]

comment:10

Replying to @mkoeppe:

Also notebook bundles mathjax ... why do we install another copy?

The change

diff --git a/build/make/Makefile.in b/build/make/Makefile.in
index ed5294cc4e..3d65767bf7 100644
--- a/build/make/Makefile.in
+++ b/build/make/Makefile.in
@@ -289,7 +289,7 @@ base: $(inst_patch) $(inst_pkgconf)
 # produce plots.
 DOC_DEPENDENCIES = sagelib $(inst_sphinx) \
        | $(SAGERUNTIME) $(inst_maxima) $(inst_networkx) $(inst_scipy) $(inst_sympy) \
-       $(inst_matplotlib) $(inst_pillow) $(inst_mathjax) $(inst_mpmath) \
+       $(inst_matplotlib) $(inst_pillow) $(inst_mpmath) \
        $(inst_ipykernel) $(inst_jupyter_client) $(inst_conway_polynomials) \
        $(inst_tachyon) $(inst_jmol) $(inst_thebe) $(inst_ipywidgets)
 
diff --git a/build/pkgs/mathjax/type b/build/pkgs/mathjax/type
index a6a7b9cd72..134d9bc32d 100644
--- a/build/pkgs/mathjax/type
+++ b/build/pkgs/mathjax/type
@@ -1 +1 @@
-standard
+optional

avoids building mathjax, but then Sphinx doesn't find it when building the documentation. So if we want to use the version bundled with notebook, we need to make sure that Sphinx knows where to find it.

[mkoeppe]

comment:11

src/sage/docs/conf.py expects sage.env.MATHJAX_DIR to be set to the location. This is what we'd have to configure if we take mathjax either from a system installation, or some other source.

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,3 +1,29 @@
 We add an `spkg-configure.m4` script for the standard package `mathjax`, as well as corresponding system package information in `build/pkgs/mathjax/distros/`
 
 
+
+
+---
+
+Random references:
+
+py-mathjax/pypi/py-mathjax at master · kiwi0fruit/py-mathjax
+https://github.com/kiwi0fruit/py-mathjax/tree/master/pypi/py-mathjax
+
+Debian JavaScript Maintainers / mathjax · [GitLab](../wiki/GitLab)
+https://salsa.debian.org/js-team/mathjax
+
+sphinx/setup.py at 3.x · sphinx-doc/sphinx
+https://github.com/sphinx-doc/sphinx/blob/3.x/setup.py
+
+Math support for HTML outputs in Sphinx — Sphinx 4.0.0+ documentation
+https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.mathjax
+
+sphinx-ext-mathjax - Google Search
+https://www.google.com/search?safe=off&sxsrf=ALeKk03spVlQ9ALPLJJCbNfF9EIdC_LYuQ%3A1596929073175&ei=MTQvX8mUCuKU0PEPu-yOiAE&q=sphinx-ext-mathjax&oq=sphinx-ext-mathjax&gs_lcp=CgZwc3ktYWIQAzIFCAAQzQIyBQgAEM0CMggIABDNAhCLAzIICAAQzQIQiwMyCAgAEM0CEIsDOgQIABBHOgcIIxCwAhAnOgcIIRAKEKABOgUIIRCgAToFCCEQqwJQmyhY4UVgtFBoAHABeACAAWqIAeUHkgEDOS4ymAEAoAEBqgEHZ3dzLXdpergBA8ABAQ&sclient=psy-ab&ved=0ahUKEwiJ8Yyx4IzrAhViCjQIHTu2AxEQ4dUDCAw&uact=5
+
+Math support for HTML outputs in Sphinx — Sphinx 4.0.0+ documentation
+https://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.mathjax
+
+sphinx/mathjax.py at 3.x · sphinx-doc/sphinx
+https://github.com/sphinx-doc/sphinx/blob/3.x/sphinx/ext/mathjax.py

[mkoeppe]

Changed commit from 68a0dda to none

[mkoeppe]

Changed branch from u/mkoeppe/system_package_information_and_spkg_configure_for_mathjax to none

[slel]

Description changed:

--- 
+++ 
@@ -1,7 +1,4 @@
 We add an `spkg-configure.m4` script for the standard package `mathjax`, as well as corresponding system package information in `build/pkgs/mathjax/distros/`
-
-
-
 
 ---
 
@@ -10,7 +7,7 @@
 py-mathjax/pypi/py-mathjax at master · kiwi0fruit/py-mathjax
 https://github.com/kiwi0fruit/py-mathjax/tree/master/pypi/py-mathjax
 
-Debian JavaScript Maintainers / mathjax · [GitLab](../wiki/GitLab)
+Debian JavaScript Maintainers / mathjax · GitLab
 https://salsa.debian.org/js-team/mathjax
 
 sphinx/setup.py at 3.x · sphinx-doc/sphinx
@@ -27,3 +24,4 @@
 
 sphinx/mathjax.py at 3.x · sphinx-doc/sphinx
 https://github.com/sphinx-doc/sphinx/blob/3.x/sphinx/ext/mathjax.py
+

[slel]

Changed keywords from none to mathjax