Render math in HTML via dvipng or dvisvgm.
Unknown Field: copyright | |
Copyright 2007-2022 by the Sphinx team, see AUTHORS. | |
Unknown Field: license | |
BSD, see LICENSE for details. |
Constant | SUPPORT_FORMAT |
Undocumented |
Variable | depth_re |
Undocumented |
Variable | depthsvg_re |
Undocumented |
Variable | depthsvgcomment_re |
Undocumented |
Variable | logger |
Undocumented |
Variable | templates_path |
Undocumented |
Class | InvokeError |
errors on invoking converters. |
Class | MathExtError |
Undocumented |
Function | cleanup_tempdir |
Undocumented |
Function | compile_math |
Compile LaTeX macros for math to DVI. |
Function | convert_dvi_to_image |
Convert DVI file to specific image format. |
Function | convert_dvi_to_png |
Convert DVI file to PNG image. |
Function | convert_dvi_to_svg |
Convert DVI file to SVG image. |
Function | ensure_tempdir |
Create temporary directory. |
Function | generate_latex_macro |
Generate LaTeX macro. |
Function | get_tooltip |
Undocumented |
Function | html_visit_displaymath |
Undocumented |
Function | html_visit_math |
Undocumented |
Function | read_svg_depth |
Read the depth from comment at last line of SVG file |
Function | render_math |
Render the LaTeX math expression math using latex and dvipng or dvisvgm. |
Function | setup |
Undocumented |
Function | write_svg_depth |
Write the depth to SVG file as a comment at end of file |
Undocumented
Parameters | |
app:Sphinx | Undocumented |
exc:Exception | Undocumented |
Parameters | |
latex:str | Undocumented |
builder:Builder | Undocumented |
Returns | |
str | Undocumented |
Parameters | |
command:List[ | Undocumented |
name:str | Undocumented |
Returns | |
Tuple[ | Undocumented |
Parameters | |
dvipath:str | Undocumented |
builder:Builder | Undocumented |
Returns | |
Tuple[ | Undocumented |
Parameters | |
dvipath:str | Undocumented |
builder:Builder | Undocumented |
Returns | |
Tuple[ | Undocumented |
Create temporary directory.
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)
Parameters | |
builder:Builder | Undocumented |
Returns | |
str | Undocumented |
Parameters | |
image_format:str | Undocumented |
math:str | Undocumented |
config:Config | Undocumented |
confdir:str | Undocumented |
Returns | |
str | Undocumented |
Parameters | |
filename:str | Undocumented |
Returns | |
int | Undocumented |
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.
Parameters | |
math:str | Undocumented |
Returns | |
Tuple[ | Undocumented |