A Sphinx extension for rendering math on HTML pages.
Project description
The extension uses KaTeX for rendering of math in HTML pages. Itis designed as a replacement for mathjax which is slower in rednering, but comes as a build in extension with sphinx sphinx.ext.mathjax.
Download: https://pypi.python.org/pypi/sphinxcontrib-katex/#downloads
Development: https://github.com/hagenw/sphinxcontrib-katex/
Usage
Installation:
pip install sphinxcontrib-katex
In your sphinx project, add the extension with:
extensions = [
'sphinxcontrib.katex',
]
If you would like to add some LaTeX macros (\def) you can use the katex_macros config setting, for example:
katex_macros = r'''
"\\i": "\\mathrm{i}",
"\\e": "\\mathrm{e}^{#1}",
"\\w": "\\omega",
"\\vec": "\\mathbf{#1}",
"\\x": "\\vec{x}",
"\\d": "\\operatorname{d}\\!{}",
"\\dirac": "\\operatorname{\\delta}\\left(#1\\right)",
"\\scalarprod": "\\left\\langle#1,#2\\right\\rangle",
'''
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinxcontrib-katex-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48fbe534c4297949e3a0404c3dbf794ca82fe03a488fb607f9dd8d2a5b6b824e |
|
MD5 | d5833a295a81b61750e54d584c46c23b |
|
BLAKE2b-256 | ab001aec359a14af0001038221432045713bc03ddea8d0a363c67e9a483e722b |
Close
Hashes for sphinxcontrib_katex-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63268b47eeecb6d2bab254c83ee8707df98a0c4fd94a287296b49c840f05b40e |
|
MD5 | c7fe342c3403d30180a72318631636ac |
|
BLAKE2b-256 | b1af224745d269edfee124ef254b7f4a9ba1feeedccd6c7c0b997087ceedc8f1 |