Skip to content

Commit 7f2cb1a

Browse files
committed
DOC: Rename sphinx.ext.jsmath to sphinxcontrib.jsmath
.. and add some minor doc improvements to it. Superseeds sphinx-doc#13785.
1 parent 5d3bb2e commit 7f2cb1a

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

doc/usage/extensions/math.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -318,14 +318,18 @@ Sphinx but is set to automatically include it from a third-party site.
318318
This has been renamed to :confval:`mathjax2_config`.
319319
:confval:`mathjax_config` is still supported for backwards compatibility.
320320

321-
:mod:`sphinx.ext.jsmath` -- Render math via JavaScript
322-
------------------------------------------------------
321+
:mod:`sphinxcontib.jsmath` -- Render math via JavaScript
322+
--------------------------------------------------------
323323

324324
.. module:: sphinx.ext.jsmath
325325
:synopsis: Render math using JavaScript via JSMath.
326326

327327
This extension works just as the MathJax extension does, but uses the older
328-
package jsMath_. It provides this config value:
328+
package jsMath_. jsMath is no longer actively developed, but it has the
329+
advantage that the size of the JavaScript package is much smaller than
330+
MathJax.
331+
332+
Config value:
329333

330334
.. confval:: jsmath_path
331335
:type: :code-py:`str`
@@ -337,7 +341,7 @@ package jsMath_. It provides this config value:
337341
The path can be absolute or relative; if it is relative, it is relative to
338342
the ``_static`` directory of the built docs.
339343

340-
For example, if you put JSMath into the static path of the Sphinx docs, this
344+
For example, if you put jsMath into the static path of the Sphinx docs, this
341345
value would be ``jsMath/easy/load.js``. If you host more than one
342346
Sphinx documentation set on one server, it is advisable to install jsMath in
343347
a shared location.
@@ -347,5 +351,5 @@ package jsMath_. It provides this config value:
347351
.. _dvisvgm: https://dvisvgm.de/
348352
.. _dvisvgm FAQ: https://dvisvgm.de/FAQ
349353
.. _MathJax: https://www.mathjax.org/
350-
.. _jsMath: https://www.math.union.edu/~dpvc/jsmath/
354+
.. _jsMath: https://www.math.union.edu/~dpvc/jsMath/
351355
.. _LaTeX preview package: https://www.gnu.org/software/auctex/preview-latex.html

0 commit comments

Comments
 (0)