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-hypernode.com/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",
'''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
File details
Details for the file sphinxcontrib-katex-0.1.2.tar.gz.
File metadata
- Download URL: sphinxcontrib-katex-0.1.2.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 59d711d0fa2ef6022caaed8f5d92a15d2b62fcbdf8f57b9ddeb9340009b3a4d6 |
|
| MD5 | 313ad21910b17be84f7bc28bf5c2b1ec |
|
| BLAKE2b-256 | 4ae5753183858b62586d4b9d018057bacd92bb0b346cb5485de89843c131972b |
File details
Details for the file sphinxcontrib_katex-0.1.2-py2.py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_katex-0.1.2-py2.py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4aab1b7e24ea56961fd827b05b872dd332a660625f41147ca606bb2a9f9ccfaf |
|
| MD5 | cd14693355f7ad3ea9e676262dfa16da |
|
| BLAKE2b-256 | 1d1c2de6f120a78b354a9cb0da8f65292bf5b6a84827d0b5bdef21be67f8bca3 |
