myst_parser.sphinx_ext.mathjax Namespace Reference

Functions
None	log_override_warning (Sphinx app, int version, str current, str new)
	override_mathjax (Sphinx app)
None	html_visit_displaymath (HTMLTranslator self, nodes.math_block node)

Variables
	logger = logging.getLogger(__name__)

Detailed Description

Overrides to ``sphinx.ext.mathjax``

This fixes two issues:

1. Mathjax should not search for ``$`` delimiters, nor LaTeX amsmath environments,
   since we already achieve this with the dollarmath and amsmath mrakdown-it-py plugins
2. amsmath math blocks should be wrapped in mathjax delimiters (default ``\\[...\\]``),
   and assigned an equation number

Function Documentation

html_visit_displaymath()

None myst_parser.sphinx_ext.mathjax.html_visit_displaymath	(	HTMLTranslator	self,
		nodes.math_block	node
	)

Override for sphinx.ext.mathjax.html_visit_displaymath to handle amsmath.

By default displaymath, are normally wrapped in a prefix/suffix,
defined by mathjax_display, and labelled nodes are numbered.
However, this is not the case if the math_block is set as 'nowrap', as for amsmath.
Therefore, we need to override this behaviour.

log_override_warning()

None myst_parser.sphinx_ext.mathjax.log_override_warning	(	Sphinx	app,
		int	version,
		str	current,
		str	new
	)

Log a warning if MathJax configuration being overridden.

override_mathjax()

myst_parser.sphinx_ext.mathjax.override_mathjax

(

Sphinx

app

)

Override aspects of the mathjax extension.

MyST-Parser parses dollar and latex math, via markdown-it plugins.
Therefore, we tell Mathjax to only render these HTML elements.
This is accompanied by setting the `ignoreClass` on the top-level section of each MyST document.