Registry / web-framework / sphinxcontrib-katex

sphinxcontrib-katex

library0.9.11pypypiunverified

A Sphinx extension for rendering LaTeX math in HTML pages using KaTeX. Current version is 0.9.11, compatible with Python >=3.9. Released irregularly.

web-framework serialization

pip install sphinxcontrib-katex

github ↗package ↗homepage ↗docs ↗

INSTALL

IMPORT

SIG · SPHINXCONTRIB-KATE

sphinxcontrib-katex

web-frameworkpythonv0.9.11

Install

5.4s avg

Import

—

Disk

94MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.9.11 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 92.2MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.4s · import 0.000s · 93MB

94MB installed

● package 94MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

katex

✓ extensions = ['sphinxcontrib.katex']

✗ extensions = ['sphinxcontrib-katex']

Uses dot notation, not hyphen

Enable the extension in Sphinx conf.py and optionally specify KaTeX version (defaults to latest available).

# conf.py extensions = ['sphinxcontrib.katex'] katex_version = '0.16.9'

Debug

Known issues

breakingIn v0.9.0+, the extension requires KaTeX >=0.16.0. Older KaTeX versions are not supported and will fail to render.

fix

Update katex_version to >=0.16.0 in conf.py or let it default.

affects: >=0.9.0

gotchaThe extension does not automatically download KaTeX. It expects KaTeX JS/CSS to be present in the _static directory or served via CDN. If you see blank pages, you may need to install KaTeX manually or adjust the path.

fix

Set katex_css_path and katex_js_path in conf.py to point to your KaTeX assets.

affects: all

deprecatedThe option 'katex_css_host' was deprecated in v0.8.0 and removed in v0.9.0. Use 'katex_css_path' and 'katex_js_path' instead.

fix

Replace katex_css_host with katex_css_path and katex_js_path.

affects: >=0.8.0

Upgrade

Version history

0.9.11latest on PyPI · released Jun 27, 2025

Audit

Dependencies

sphinxrequiredRequired extension mechanism

katexoptionalJavaScript frontend (usually bundled, but version mismatch can occur)

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/hagenw/sphinxcontrib-katex ↗

packagehttps://pypi.org/project/sphinxcontrib-katex/ ↗

homepagehttps://www.sphinx-doc.org/en/master/usage/extensions/math.html ↗

docshttps://sphinxcontrib-katex.readthedocs.io ↗