mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Add the imgmath extension, the successor of pngmath.
In addition to the features which pngmath supports, imgmath also supports svg output format.
This commit is contained in:
Hong Xu
parent
026fde47b0
commit
355fe2a233
280
sphinx/ext/imgmath.py
Normal file
280
sphinx/ext/imgmath.py
Normal file
@ -0,0 +1,280 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""
|
||||||
|
sphinx.ext.imgmath
|
||||||
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Render math in HTML via dvipng or dvisvgm.
|
||||||
|
|
||||||
|
:copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
|
||||||
|
:license: BSD, see LICENSE for details.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import re
|
||||||
|
import codecs
|
||||||
|
import shutil
|
||||||
|
import tempfile
|
||||||
|
import posixpath
|
||||||
|
from os import path
|
||||||
|
from subprocess import Popen, PIPE
|
||||||
|
from hashlib import sha1
|
||||||
|
|
||||||
|
from six import text_type
|
||||||
|
from docutils import nodes
|
||||||
|
|
||||||
|
import sphinx
|
||||||
|
from sphinx.errors import SphinxError
|
||||||
|
from sphinx.util.png import read_png_depth, write_png_depth
|
||||||
|
from sphinx.util.osutil import ensuredir, ENOENT, cd
|
||||||
|
from sphinx.util.pycompat import sys_encoding
|
||||||
|
from sphinx.ext.mathbase import setup_math as mathbase_setup, wrap_displaymath
|
||||||
|
|
||||||
|
|
||||||
|
class MathExtError(SphinxError):
|
||||||
|
category = 'Math extension error'
|
||||||
|
|
||||||
|
def __init__(self, msg, stderr=None, stdout=None):
|
||||||
|
if stderr:
|
||||||
|
msg += '\n[stderr]\n' + stderr.decode(sys_encoding, 'replace')
|
||||||
|
if stdout:
|
||||||
|
msg += '\n[stdout]\n' + stdout.decode(sys_encoding, 'replace')
|
||||||
|
SphinxError.__init__(self, msg)
|
||||||
|
|
||||||
|
|
||||||
|
DOC_HEAD = r'''
|
||||||
|
\documentclass[12pt]{article}
|
||||||
|
\usepackage[utf8x]{inputenc}
|
||||||
|
\usepackage{amsmath}
|
||||||
|
\usepackage{amsthm}
|
||||||
|
\usepackage{amssymb}
|
||||||
|
\usepackage{amsfonts}
|
||||||
|
\usepackage{bm}
|
||||||
|
\pagestyle{empty}
|
||||||
|
'''
|
||||||
|
|
||||||
|
DOC_BODY = r'''
|
||||||
|
\begin{document}
|
||||||
|
%s
|
||||||
|
\end{document}
|
||||||
|
'''
|
||||||
|
|
||||||
|
DOC_BODY_PREVIEW = r'''
|
||||||
|
\usepackage[active]{preview}
|
||||||
|
\begin{document}
|
||||||
|
\begin{preview}
|
||||||
|
%s
|
||||||
|
\end{preview}
|
||||||
|
\end{document}
|
||||||
|
'''
|
||||||
|
|
||||||
|
depth_re = re.compile(br'\[\d+ depth=(-?\d+)\]')
|
||||||
|
|
||||||
|
|
||||||
|
def render_math(self, math):
|
||||||
|
"""Render the LaTeX math expression *math* using latex and dvipng or
|
||||||
|
dvisvgm.
|
||||||
|
|
||||||
|
Return the filename relative to the built document and the "depth",
|
||||||
|
that is, the distance of image bottom and baseline in pixels, if the
|
||||||
|
option to use preview_latex is switched on.
|
||||||
|
|
||||||
|
Error handling may seem strange, but follows a pattern: if LaTeX or dvipng
|
||||||
|
(dvisvgm) aren't available, only a warning is generated (since that enables
|
||||||
|
people on machines without these programs to at least build the rest of the
|
||||||
|
docs successfully). If the programs are there, however, they may not fail
|
||||||
|
since that indicates a problem in the math source.
|
||||||
|
"""
|
||||||
|
image_format = self.builder.config.imgmath_image_format
|
||||||
|
if image_format not in ('png', 'svg'):
|
||||||
|
raise MathExtError(
|
||||||
|
'imgmath_image_format must be either "png" or "svg"')
|
||||||
|
|
||||||
|
use_preview = self.builder.config.imgmath_use_preview
|
||||||
|
latex = DOC_HEAD + self.builder.config.imgmath_latex_preamble
|
||||||
|
latex += (use_preview and DOC_BODY_PREVIEW or DOC_BODY) % math
|
||||||
|
|
||||||
|
shasum = "%s.%s" % (sha1(latex.encode('utf-8')).hexdigest(), image_format)
|
||||||
|
relfn = posixpath.join(self.builder.imgpath, 'math', shasum)
|
||||||
|
outfn = path.join(self.builder.outdir, self.builder.imagedir, 'math', shasum)
|
||||||
|
if path.isfile(outfn):
|
||||||
|
depth = read_png_depth(outfn)
|
||||||
|
return relfn, depth
|
||||||
|
|
||||||
|
# if latex or dvipng (dvisvgm) has failed once, don't bother to try again
|
||||||
|
if hasattr(self.builder, '_imgmath_warned_latex') or \
|
||||||
|
hasattr(self.builder, '_imgmath_warned_image_translator'):
|
||||||
|
return None, None
|
||||||
|
|
||||||
|
# use only one tempdir per build -- the use of a directory is cleaner
|
||||||
|
# than using temporary files, since we can clean up everything at once
|
||||||
|
# just removing the whole directory (see cleanup_tempdir)
|
||||||
|
if not hasattr(self.builder, '_imgmath_tempdir'):
|
||||||
|
tempdir = self.builder._imgmath_tempdir = tempfile.mkdtemp()
|
||||||
|
else:
|
||||||
|
tempdir = self.builder._imgmath_tempdir
|
||||||
|
|
||||||
|
tf = codecs.open(path.join(tempdir, 'math.tex'), 'w', 'utf-8')
|
||||||
|
tf.write(latex)
|
||||||
|
tf.close()
|
||||||
|
|
||||||
|
# build latex command; old versions of latex don't have the
|
||||||
|
# --output-directory option, so we have to manually chdir to the
|
||||||
|
# temp dir to run it.
|
||||||
|
ltx_args = [self.builder.config.imgmath_latex, '--interaction=nonstopmode']
|
||||||
|
# add custom args from the config file
|
||||||
|
ltx_args.extend(self.builder.config.imgmath_latex_args)
|
||||||
|
ltx_args.append('math.tex')
|
||||||
|
|
||||||
|
with cd(tempdir):
|
||||||
|
try:
|
||||||
|
p = Popen(ltx_args, stdout=PIPE, stderr=PIPE)
|
||||||
|
except OSError as err:
|
||||||
|
if err.errno != ENOENT: # No such file or directory
|
||||||
|
raise
|
||||||
|
self.builder.warn('LaTeX command %r cannot be run (needed for math '
|
||||||
|
'display), check the imgmath_latex setting' %
|
||||||
|
self.builder.config.imgmath_latex)
|
||||||
|
self.builder._imgmath_warned_latex = True
|
||||||
|
return None, None
|
||||||
|
|
||||||
|
stdout, stderr = p.communicate()
|
||||||
|
if p.returncode != 0:
|
||||||
|
raise MathExtError('latex exited with error', stderr, stdout)
|
||||||
|
|
||||||
|
ensuredir(path.dirname(outfn))
|
||||||
|
if image_format == 'png':
|
||||||
|
image_translator = 'dvipng'
|
||||||
|
image_translator_executable = self.builder.config.imgmath_dvipng
|
||||||
|
# use some standard dvipng arguments
|
||||||
|
image_translator_args = [self.builder.config.imgmath_dvipng]
|
||||||
|
image_translator_args += ['-o', outfn, '-T', 'tight', '-z9']
|
||||||
|
# add custom ones from config value
|
||||||
|
image_translator_args.extend(self.builder.config.imgmath_dvipng_args)
|
||||||
|
if use_preview:
|
||||||
|
image_translator_args.append('--depth')
|
||||||
|
elif image_format == 'svg':
|
||||||
|
image_translator = 'dvisvgm'
|
||||||
|
image_translator_executable = self.builder.config.imgmath_dvisvgm
|
||||||
|
# use some standard dvisvgm arguments
|
||||||
|
image_translator_args = [self.builder.config.imgmath_dvisvgm]
|
||||||
|
image_translator_args += ['-o', outfn]
|
||||||
|
# add custom ones from config value
|
||||||
|
image_translator_args.extend(self.builder.config.imgmath_dvisvgm_args)
|
||||||
|
# last, the input file name
|
||||||
|
image_translator_args.append(path.join(tempdir, 'math.dvi'))
|
||||||
|
else:
|
||||||
|
raise MathExtError(
|
||||||
|
'imgmath_image_format must be either "png" or "svg"')
|
||||||
|
|
||||||
|
# last, the input file name
|
||||||
|
image_translator_args.append(path.join(tempdir, 'math.dvi'))
|
||||||
|
|
||||||
|
try:
|
||||||
|
p = Popen(image_translator_args, stdout=PIPE, stderr=PIPE)
|
||||||
|
except OSError as err:
|
||||||
|
if err.errno != ENOENT: # No such file or directory
|
||||||
|
raise
|
||||||
|
self.builder.warn('%s command %r cannot be run (needed for math '
|
||||||
|
'display), check the imgmath_%s setting' %
|
||||||
|
image_translator, image_translator_executable,
|
||||||
|
image_translator)
|
||||||
|
self.builder._imgmath_warned_image_translator = True
|
||||||
|
return None, None
|
||||||
|
|
||||||
|
stdout, stderr = p.communicate()
|
||||||
|
if p.returncode != 0:
|
||||||
|
raise MathExtError('%s exited with error',
|
||||||
|
image_translator, stderr, stdout)
|
||||||
|
depth = None
|
||||||
|
if use_preview and image_format == 'png': # depth is only useful for png
|
||||||
|
for line in stdout.splitlines():
|
||||||
|
m = depth_re.match(line)
|
||||||
|
if m:
|
||||||
|
depth = int(m.group(1))
|
||||||
|
write_png_depth(outfn, depth)
|
||||||
|
break
|
||||||
|
|
||||||
|
return relfn, depth
|
||||||
|
|
||||||
|
|
||||||
|
def cleanup_tempdir(app, exc):
|
||||||
|
if exc:
|
||||||
|
return
|
||||||
|
if not hasattr(app.builder, '_imgmath_tempdir'):
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
shutil.rmtree(app.builder._mathpng_tempdir)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def get_tooltip(self, node):
|
||||||
|
if self.builder.config.imgmath_add_tooltips:
|
||||||
|
return ' alt="%s"' % self.encode(node['latex']).strip()
|
||||||
|
return ''
|
||||||
|
|
||||||
|
|
||||||
|
def html_visit_math(self, node):
|
||||||
|
try:
|
||||||
|
fname, depth = render_math(self, '$'+node['latex']+'$')
|
||||||
|
except MathExtError as exc:
|
||||||
|
msg = text_type(exc)
|
||||||
|
sm = nodes.system_message(msg, type='WARNING', level=2,
|
||||||
|
backrefs=[], source=node['latex'])
|
||||||
|
sm.walkabout(self)
|
||||||
|
self.builder.warn('display latex %r: ' % node['latex'] + msg)
|
||||||
|
raise nodes.SkipNode
|
||||||
|
if fname is None:
|
||||||
|
# something failed -- use text-only as a bad substitute
|
||||||
|
self.body.append('<span class="math">%s</span>' %
|
||||||
|
self.encode(node['latex']).strip())
|
||||||
|
else:
|
||||||
|
c = ('<img class="math" src="%s"' % fname) + get_tooltip(self, node)
|
||||||
|
if depth is not None:
|
||||||
|
c += ' style="vertical-align: %dpx"' % (-depth)
|
||||||
|
self.body.append(c + '/>')
|
||||||
|
raise nodes.SkipNode
|
||||||
|
|
||||||
|
|
||||||
|
def html_visit_displaymath(self, node):
|
||||||
|
if node['nowrap']:
|
||||||
|
latex = node['latex']
|
||||||
|
else:
|
||||||
|
latex = wrap_displaymath(node['latex'], None)
|
||||||
|
try:
|
||||||
|
fname, depth = render_math(self, latex)
|
||||||
|
except MathExtError as exc:
|
||||||
|
sm = nodes.system_message(str(exc), type='WARNING', level=2,
|
||||||
|
backrefs=[], source=node['latex'])
|
||||||
|
sm.walkabout(self)
|
||||||
|
self.builder.warn('inline latex %r: ' % node['latex'] + str(exc))
|
||||||
|
raise nodes.SkipNode
|
||||||
|
self.body.append(self.starttag(node, 'div', CLASS='math'))
|
||||||
|
self.body.append('<p>')
|
||||||
|
if node['number']:
|
||||||
|
self.body.append('<span class="eqno">(%s)</span>' % node['number'])
|
||||||
|
if fname is None:
|
||||||
|
# something failed -- use text-only as a bad substitute
|
||||||
|
self.body.append('<span class="math">%s</span></p>\n</div>' %
|
||||||
|
self.encode(node['latex']).strip())
|
||||||
|
else:
|
||||||
|
self.body.append(('<img src="%s"' % fname) + get_tooltip(self, node) +
|
||||||
|
'/></p>\n</div>')
|
||||||
|
raise nodes.SkipNode
|
||||||
|
|
||||||
|
|
||||||
|
def setup(app):
|
||||||
|
mathbase_setup(app, (html_visit_math, None), (html_visit_displaymath, None))
|
||||||
|
app.add_config_value('imgmath_image_format', 'png', 'html')
|
||||||
|
app.add_config_value('imgmath_dvipng', 'dvipng', 'html')
|
||||||
|
app.add_config_value('imgmath_dvisvgm', 'dvisvgm', 'html')
|
||||||
|
app.add_config_value('imgmath_latex', 'latex', 'html')
|
||||||
|
app.add_config_value('imgmath_use_preview', False, 'html')
|
||||||
|
app.add_config_value('imgmath_dvipng_args',
|
||||||
|
['-gamma', '1.5', '-D', '110', '-bg', 'Transparent'],
|
||||||
|
'html')
|
||||||
|
app.add_config_value('imgmath_dvisvgm_args', ['--no-fonts'], 'html')
|
||||||
|
app.add_config_value('imgmath_latex_args', [], 'html')
|
||||||
|
app.add_config_value('imgmath_latex_preamble', '', 'html')
|
||||||
|
app.add_config_value('imgmath_add_tooltips', True, 'html')
|
||||||
|
app.connect('build-finished', cleanup_tempdir)
|
||||||
|
return {'version': sphinx.__display_version__, 'parallel_read_safe': True}
|
||||||
4
tests/roots/test-ext-imgmath/conf.py
Normal file
4
tests/roots/test-ext-imgmath/conf.py
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
extensions = ['sphinx.ext.imgmath']
|
||||||
|
master_doc = 'index'
|
||||||
6
tests/roots/test-ext-imgmath/index.rst
Normal file
6
tests/roots/test-ext-imgmath/index.rst
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
Test imgmath
|
||||||
|
============
|
||||||
|
|
||||||
|
.. math:: a^2+b^2=c^2
|
||||||
|
|
||||||
|
Inline :math:`E=mc^2`
|
||||||
42
tests/test_ext_imgmath.py
Normal file
42
tests/test_ext_imgmath.py
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
"""
|
||||||
|
test_ext_imgmath
|
||||||
|
~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Test sphinx.ext.imgmath extension.
|
||||||
|
|
||||||
|
:copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
|
||||||
|
:license: BSD, see LICENSE for details.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import re
|
||||||
|
|
||||||
|
from util import with_app, SkipTest
|
||||||
|
|
||||||
|
|
||||||
|
@with_app('html', testroot='ext-imgmath')
|
||||||
|
def test_imgmath_png(app, status, warning):
|
||||||
|
app.builder.build_all()
|
||||||
|
if "LaTeX command 'latex' cannot be run" in warning.getvalue():
|
||||||
|
raise SkipTest('LaTeX command "latex" is not available')
|
||||||
|
if "dvipng command 'dvipng' cannot be run" in warning.getvalue():
|
||||||
|
raise SkipTest('dvipng command "dvipng" is not available')
|
||||||
|
|
||||||
|
content = (app.outdir / 'index.html').text()
|
||||||
|
html = ('<div class="math">\s*<p>\s*<img src="_images/math/\w+.png"'
|
||||||
|
'\s*alt="a\^2\+b\^2=c\^2"/>\s*</p>\s*</div>')
|
||||||
|
assert re.search(html, content, re.S)
|
||||||
|
|
||||||
|
@with_app('html', testroot='ext-imgmath',
|
||||||
|
confoverrides={'imgmath_image_format': 'svg'})
|
||||||
|
def test_imgmath_svg(app, status, warning):
|
||||||
|
app.builder.build_all()
|
||||||
|
if "LaTeX command 'latex' cannot be run" in warning.getvalue():
|
||||||
|
raise SkipTest('LaTeX command "latex" is not available')
|
||||||
|
if "dvisvgm command 'dvisvgm' cannot be run" in warning.getvalue():
|
||||||
|
raise SkipTest('dvisvgm command "dvisvgm" is not available')
|
||||||
|
|
||||||
|
content = (app.outdir / 'index.html').text()
|
||||||
|
html = ('<div class="math">\s*<p>\s*<img src="_images/math/\w+.svg"'
|
||||||
|
'\s*alt="a\^2\+b\^2=c\^2"/>\s*</p>\s*</div>')
|
||||||
|
assert re.search(html, content, re.S)
|
||||||
Loading…
Reference in New Issue
Block a user