Skip to main content

Latex specific features for jupyter book

Project description


Documentation Status

Sphinx extension to support LaTeX infrastructure for Jupyter Book.

This repository is a development project to improve LaTeX support in Jupyter Book.

Get started

To get started with sphinx-jupyterbook-latex, first install it through pip:

pip install sphinx-jupyterbook-latex

then, add sphinx_jupyterbook_latex to your extensions, in a Sphinx

extensions = ["sphinx_jupyterbook_latex"]

# autoload the sphinx.ext.imgconverter extension, optional (default is True)
# jblatex_load_imgconverter = True
# turn root level toctree captions into top-level `part` headings, optional (default is to auto-infer)
#  jblatex_captions_to_parts = True

OR in the jupyterbook config.yml:

    - sphinx_jupyterbook_latex
    # config:
    #   jblatex_load_imgconverter: true
    #   jblatex_captions_to_parts: true

Extension Details

This extension does not provide an actual Sphinx LaTeX theme, instead it instantiates a number of transforms (for LaTeX builders only) that manipulate the AST into the required format:

  1. Overrides some configuration:
  • latex_engine -> xelatex
  • latex_theme -> jupyterBook
  • appends necessary LaTeX commands to the preamble
  1. When a latex builder is specified:
  • Set's up sphinx.ext.imgconverter (if jblatex_load_imgconverter)
  • Replace sub-headers in the root document
  • Create headings from the root-level toctree captions (if jblatex_captions_to_parts)
  • Move bibliographies to the bottom of the document


A list of issues that need to be addressed:

Developer Notes

A repository that contains many different project configurations for testing and development is available, along with implementation idea and notes

Project details

Download files

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

Source Distribution

sphinx_jupyterbook_latex-1.0.0.tar.gz (11.9 kB view hashes)

Uploaded Source

Built Distribution

sphinx_jupyterbook_latex-1.0.0-py3-none-any.whl (13.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page