mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
bb9cde4e32
This is a follow-up commit of #2254, which supported alignment of multiple equations for imgmath and LaTeX output.
78 lines
3.0 KiB
Python
78 lines
3.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
sphinx.ext.mathjax
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
Allow `MathJax <http://mathjax.org/>`_ to be used to display math in
|
|
Sphinx's HTML writer -- requires the MathJax JavaScript library on your
|
|
webserver/computer.
|
|
|
|
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
from docutils import nodes
|
|
|
|
import sphinx
|
|
from sphinx.application import ExtensionError
|
|
from sphinx.ext.mathbase import setup_math as mathbase_setup
|
|
|
|
|
|
def html_visit_math(self, node):
|
|
self.body.append(self.starttag(node, 'span', '', CLASS='math'))
|
|
self.body.append(self.builder.config.mathjax_inline[0] +
|
|
self.encode(node['latex']) +
|
|
self.builder.config.mathjax_inline[1] + '</span>')
|
|
raise nodes.SkipNode
|
|
|
|
|
|
def html_visit_displaymath(self, node):
|
|
self.body.append(self.starttag(node, 'div', CLASS='math'))
|
|
if node['nowrap']:
|
|
self.body.append(self.builder.config.mathjax_display[0] +
|
|
self.encode(node['latex']) +
|
|
self.builder.config.mathjax_display[1])
|
|
self.body.append('</div>')
|
|
raise nodes.SkipNode
|
|
|
|
# necessary to e.g. set the id property correctly
|
|
if node['number']:
|
|
self.body.append('<span class="eqno">(%s)</span>' % node['number'])
|
|
self.body.append(self.builder.config.mathjax_display[0])
|
|
parts = [prt for prt in node['latex'].split('\n\n') if prt.strip()]
|
|
if len(parts) > 1: # Add alignment if there are more than 1 equation
|
|
self.body.append(r' \begin{align}\begin{aligned}')
|
|
for i, part in enumerate(parts):
|
|
part = self.encode(part)
|
|
if r'\\' in part:
|
|
self.body.append(r'\begin{split}' + part + r'\end{split}')
|
|
else:
|
|
self.body.append(part)
|
|
if i < len(parts) - 1: # append new line if not the last equation
|
|
self.body.append(r'\\')
|
|
if len(parts) > 1: # Add alignment if there are more than 1 equation
|
|
self.body.append(r'\end{aligned}\end{align} ')
|
|
self.body.append(self.builder.config.mathjax_display[1])
|
|
self.body.append('</div>\n')
|
|
raise nodes.SkipNode
|
|
|
|
|
|
def builder_inited(app):
|
|
if not app.config.mathjax_path:
|
|
raise ExtensionError('mathjax_path config value must be set for the '
|
|
'mathjax extension to work')
|
|
app.add_javascript(app.config.mathjax_path)
|
|
|
|
|
|
def setup(app):
|
|
mathbase_setup(app, (html_visit_math, None), (html_visit_displaymath, None))
|
|
# more information for mathjax secure url is here:
|
|
# http://docs.mathjax.org/en/latest/start.html#secure-access-to-the-cdn
|
|
app.add_config_value('mathjax_path',
|
|
'https://cdn.mathjax.org/mathjax/latest/MathJax.js?'
|
|
'config=TeX-AMS-MML_HTMLorMML', False)
|
|
app.add_config_value('mathjax_inline', [r'\(', r'\)'], 'html')
|
|
app.add_config_value('mathjax_display', [r'\[', r'\]'], 'html')
|
|
app.connect('builder-inited', builder_inited)
|
|
return {'version': sphinx.__display_version__, 'parallel_read_safe': True}
|