docutils.utils.math Namespace Reference

Namespaces
namespace	latex2mathml
namespace	mathml_elements
namespace	tex2mathml_extern

Classes
class	MathError

Functions
	toplevel_code (code)
	pick_math_environment (code, numbered=False)
	wrap_math_code (code, as_block)

Detailed Description

This is the Docutils (Python Documentation Utilities) "math" sub-package.

It contains various modules for conversion between different math formats
(LaTeX, MathML, HTML).

:math2html:    LaTeX math -> HTML conversion from eLyXer
:latex2mathml: LaTeX math -> presentational MathML
:unichar2tex:  Unicode character to LaTeX math translation table
:tex2unichar:  LaTeX math to Unicode character translation dictionaries
:mathalphabet2unichar:  LaTeX math alphabets to Unicode character translation
:tex2mathml_extern: Wrapper for 3rd party TeX -> MathML converters

Function Documentation

pick_math_environment()

docutils.utils.math.pick_math_environment	(		code,
			numbered = False
	)

Return the right math environment to display `code`.

The test simply looks for line-breaks (``\\``) outside environments.
Multi-line formulae are set with ``align``, one-liners with
``equation``.

If `numbered` evaluates to ``False``, the "starred" versions are used
to suppress numbering.

toplevel_code()

docutils.utils.math.toplevel_code

(

code

)

Return string (LaTeX math) `code` with environments stripped out.