Skip to main content

A Sphinx extension for rendering math in HTML pages

Project description

sphinxcontrib-katex

sphinxcontrib.katex on TravisCI sphinxcontrib.katex's documentation on Read the Docs sphinxcontrib.katex's MIT license

A Sphinx extension for rendering math in HTML pages.

The extension uses KaTeX for rendering of math in HTML pages. It is designed as a replacement for the built-in extension sphinx.ext.mathjax, which uses MathJax for rendering.

Installation

To install sphinxcontrib.katex into your Python virtual environment run:

$ pip install sphinxcontrib-katex

If you want to pre-render the math by running Javascript on your server instead of running it in the browsers of the users, you have to install katex on your server and add it to your path:

$ npm install katex
$ PATH="${PATH}:$(pwd)/node_modules/.bin"

Usage

In conf.py of your Sphinx project, add the extension with:

extensions = ['sphinxcontrib.katex']

For enable server side pre-rendering add in addition:

katex_prerender = True

See the Configuration section for all availble settings.

Configuration

The behavior of sphinxcontrib.katex can be changed by configuration entries in conf.py of your documentation project. In the following all configuration entries are listed and their default values are shown.

katex_css_path = \
    'https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.css'
katex_js_path = \
    'https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.js'
katex_autorender_path = \
    'https://cdn.jsdelivr.net/npm/katex@0.13.11/contrib/auto-render.min.js'
katex_inline = [r'\(', r'\)']
katex_display = [r'\[', r'\]']
katex_prerender = False
katex_options = ''

The specific delimiters written to HTML when math mode is encountered are controlled by the two lists katex_inline and katex_display.

If katex_prerender is set to True the equations will be pre-rendered on the server and loading of the page in the browser will be faster. On your server you must have a katex executable installed and in your PATH as described in the Installation section.

The string variable katex_options allows you to change all available official KaTeX rendering options, e.g.

katex_options = r'''{
    displayMode: true,
    macros: {
        "\\RR": "\\mathbb{R}"
    }
}'''

You can also add KaTeX auto-rendering options to katex_options, but be aware that the delimiters entry should contain the entries of katex_inline and katex_display.

LaTeX Macros

Most probably you want to add some of your LaTeX math commands for the rendering. In KaTeX this is supported by LaTeX macros (\def). You can use the katex_options configuration setting to add those:

katex_options = r'''macros: {
        "\\i": "\\mathrm{i}",
        "\\e": "\\mathrm{e}^{#1}",
        "\\vec": "\\mathbf{#1}",
        "\\x": "\\vec{x}",
        "\\d": "\\operatorname{d}\\!{}",
        "\\dirac": "\\operatorname{\\delta}\\left(#1\\right)",
        "\\scalarprod": "\\left\\langle#1,#2\\right\\rangle",
    }'''

The disadvantage of this option is that those macros will be only available in the HTML based Sphinx builders. If you want to use them in the LaTeX based builders as well you have to add them as the latex_macros setting in your conf.py and specify them using proper LaTeX syntax. Afterwards you can include them via the sphinxcontrib.katex.latex_defs_to_katex_macros function into katex_options and add them to the LaTeX preamble:

import sphinxcontrib.katex as katex

latex_macros = r"""
    \def \i                {\mathrm{i}}
    \def \e              #1{\mathrm{e}^{#1}}
    \def \vec            #1{\mathbf{#1}}
    \def \x                {\vec{x}}
    \def \d                {\operatorname{d}\!}
    \def \dirac          #1{\operatorname{\delta}\left(#1\right)}
    \def \scalarprod   #1#2{\left\langle#1,#2\right\rangle}
"""

# Translate LaTeX macros to KaTeX and add to options for HTML builder
katex_macros = katex.latex_defs_to_katex_macros(latex_macros)
katex_options = 'macros: {' + katex_macros + '}'

# Add LaTeX macros for LATEX builder
latex_elements = {'preamble': latex_macros}

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Version 0.8.6 (2021-05-27)

  • Fixed: allow to work with Sphinx>=4.0.0

Version 0.8.5 (2021-05-26)

  • Fixed: remove extra space after inline math when using pre-rendering

Version 0.8.4 (2021-05-18)

  • Changed: increase top padding of equations by 2px

Version 0.8.3 (2021-05-18)

  • Fixed: building of documentation on RTD

Version 0.8.2 (2021-05-18)

  • Fixed: PyPI package version number

Version 0.8.1 (2021-05-18)

  • Fixed: PyPI package had wrong version number

Version 0.8.0 (2021-05-18)

  • Added: support for Python 3.9
  • Added: support for Sphinx>=4.0.0
  • Added: tests for Windows and macOS
  • Changed: switch to KaTeX 0.13.11
  • Changed: switched CI tests from Travis to Github Actions
  • Changed: running sphinx will now fail in pre-render mode if KaTeX fails
  • Removed: support for Python 2.7, 3.4, 3.5

Version 0.7.2 (2021-04-28)

  • Fixed: Sphinx>=4.0.0 is not supported at the moment

Version 0.7.1 (2020-10-29)

  • Fixed: label of fraction example in docs

Version 0.7.0 (2020-10-29)

  • Added: fraction example to docs
  • Changed: switch to KaTeX 0.12.0
  • Changed: add small top and bottom padding to equations

Version 0.6.1 (2020-05-25)

  • Fixed: run katex under Windows

Version 0.6.0 (2020-02-13)

  • Changed: switch to Katex 0.11.1
  • Changed: add tests for Python 3.7 and 3.8

Version 0.5.1 (2019-08-13)

  • Added: equation numbers in documentation (#16)
  • Changed: subset of tests for sphinx<=1.6 (#23)
  • Changed: several improvements to documentation

Version 0.5.0 (2019-07-25)

  • Added: katex server side pre-rendering (#15)
  • Changed: switch to Katex 0.10.2 (#17)
  • Removed: deprecated Sphinx setup_math (#10)

Version 0.4.1 (2019-01-08)

  • Fixed: macros example in documentation

Version 0.4.0 (2018-12-14)

  • Added: Sphinx documentation and setup RTD page
  • Added: Travis-CI tests
  • Changed: KaTeX version 0.10.0
  • Changed: make compatible with sphinx>=1.6
  • Removed: configuration option katex_version

Version 0.3.1 (2018-10-08)

  • Fixed: incompatibility with sphinx>=1.8 (#8)

Version 0.3.0 (2018-09-06)

  • Added: allow for user defined autorendering delimiters (#7)
  • Fixed: bug if katex_options was blank (#5)

Version 0.2.0 (2018-06-22)

  • Added: document all configuration settings
  • Added: automatic setting of delimiters for KaTeX auto-renderer
  • Removed: katex_macros option

Version 0.1.6 (2018-04-12)

  • Added: equation numbering across pages with sphinx>=1.7
  • Changed: KaTeX version 0.9.0

Version 0.1.5 (2017-12-19)

  • Added: helper function to convert LaTeX defs to KaTeX macros
  • Changed: improvement of code readability
  • Fixed: mouse over for equation numbers in Firefox

Version 0.1.4 (2017-11-27)

  • Changed: move equation numbers to the right and center vertically

Version 0.1 (2017-11-24)

  • Added: initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-katex, version 0.8.6
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_katex-0.8.6-py3-none-any.whl (10.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinxcontrib-katex-0.8.6.tar.gz (17.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page