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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddaf8b4847626710ce4716b6874dcfb1141a8f6997723e286c96eafddae2cb1b |
|
MD5 | 4285680a6061b9fe1d7fc611ee0af781 |
|
BLAKE2b-256 | 50cdcccd9a7f428c038ef0dd5765e09dfdd17d85666b7cc15f53d7ca861b4a18 |
Close
Hashes for sphinxcontrib_katex-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fb53fb76071753c9dc1fb8f386514765d1ee575037f5218e8f0fe3363397db4 |
|
MD5 | da962c50aaf3416fa2abc6bdd8733ddb |
|
BLAKE2b-256 | a311dd26947f632abe581128e35e300d322b2edff6138610a4467453ff0f31d3 |