{"id":22393,"library":"sphinxcontrib-katex","title":"sphinxcontrib-katex","description":"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.","status":"active","version":"0.9.11","language":"python","source_language":"en","source_url":"https://github.com/missinglink/sphinxcontrib-katex","tags":["sphinx","katex","math","latex","documentation"],"install":[{"cmd":"pip install sphinxcontrib-katex","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Required extension mechanism","package":"sphinx","optional":false},{"reason":"JavaScript frontend (usually bundled, but version mismatch can occur)","package":"katex","optional":true}],"imports":[{"note":"Uses dot notation, not hyphen","wrong":"extensions = ['sphinxcontrib-katex']","symbol":"katex","correct":"extensions = ['sphinxcontrib.katex']"}],"quickstart":{"code":"# conf.py\nextensions = ['sphinxcontrib.katex']\nkatex_version = '0.16.9'","lang":"python","description":"Enable the extension in Sphinx conf.py and optionally specify KaTeX version (defaults to latest available)."},"warnings":[{"fix":"Update katex_version to >=0.16.0 in conf.py or let it default.","message":"In v0.9.0+, the extension requires KaTeX >=0.16.0. Older KaTeX versions are not supported and will fail to render.","severity":"breaking","affected_versions":">=0.9.0"},{"fix":"Set katex_css_path and katex_js_path in conf.py to point to your KaTeX assets.","message":"The 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.","severity":"gotcha","affected_versions":"all"},{"fix":"Replace katex_css_host with katex_css_path and katex_js_path.","message":"The 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.","severity":"deprecated","affected_versions":">=0.8.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Install sphinxcontrib-katex via pip: pip install sphinxcontrib-katex","cause":"Missing sphinxcontrib package or incorrect import path.","error":"Extension error: Could not import extension sphinxcontrib.katex (exception: No module named 'sphinxcontrib')"},{"fix":"Set katex_version to >=0.16.0 in conf.py, e.g., katex_version = '0.16.9'","cause":"KaTeX version too old for this extension version.","error":"WARNING: katex_version '0.15.0' is not supported. Minimum required is 0.16.0"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}