IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for mathjax2_config and mathjax3_config

Browse Source
This commit is contained in:
Matthias Geier 2021-04-24 10:39:34 +02:00
parent 534a2a648b
commit 7b9cc0563d
1 changed files with 42 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
doc/usage/extensions/math.rst
View File

@ -144,7 +144,8 @@ are built:
Version 4.0 changes the version of MathJax used to version 3. You may need to Version 4.0 changes the version of MathJax used to version 3. You may need to
override ``mathjax_path`` to override ``mathjax_path`` to
``https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML`` ``https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML``
or update your configuration options for version 3. or update your configuration options for version 3
(see :confval:`mathjax3_config`).
.. versionadded:: 1.1 .. versionadded:: 1.1
@ -199,24 +200,58 @@ Sphinx but is set to automatically include it from a third-party site.
.. versionadded:: 1.8 .. versionadded:: 1.8
.. confval:: mathjax_config .. confval:: mathjax3_config
The inline configuration options for mathjax. The value is used as a The configuration options for MathJax v3 (which is used by default).
parameter of ``MathJax.Hub.Config()``. For more information, please The given dictionary is assigned to the JavaScript variable
read `Using in-line configuration options`_. ``window.MathJax``.
For more information, please read `Configuring MathJax`__.
__ https://docs.mathjax.org/en/latest/web/configuration.html#configuration
The default is empty (not configured).
.. versionadded:: 4.0
.. confval:: mathjax2_config
The configuration options for MathJax v2 (which can be loaded via
:confval:`mathjax_path`).
The value is used as a parameter of ``MathJax.Hub.Config()``.
For more information, please read `Using in-line configuration options`__.
__ http://docs.mathjax.org/en/v2.7-latest/
configuration.html#using-in-line-configuration-options
For example:: For example::
mathjax_config = { mathjax2_config = {
'extensions': ['tex2jax.js'], 'extensions': ['tex2jax.js'],
'jax': ['input/TeX', 'output/HTML-CSS'], 'jax': ['input/TeX', 'output/HTML-CSS'],
} }
The default is empty (not configured). The default is empty (not configured).
.. versionadded:: 4.0
:confval:`mathjax_config` has been renamed to :confval:`mathjax2_config`.
.. confval:: mathjax_config
Former name of :confval:`mathjax2_config`.
For help converting your old MathJax configuration to to the new
:confval:`mathjax3_config`, see `Converting Your v2 Configuration to v3`__.
__ https://docs.mathjax.org/en/latest/web/
configuration.html#converting-your-v2-configuration-to-v3
.. versionadded:: 1.8 .. versionadded:: 1.8
.. _Using in-line configuration options: https://docs.mathjax.org/en/latest/configuration.html#using-in-line-configuration-options .. versionchanged:: 4.0
This has been renamed to :confval:`mathjax2_config`.
:confval:`mathjax_config` is still supported for backwards compatibility.
:mod:`sphinx.ext.jsmath` -- Render math via JavaScript :mod:`sphinx.ext.jsmath` -- Render math via JavaScript
------------------------------------------------------ ------------------------------------------------------