sphinx-jupyterbook-latex

What it is and what it does

sphinx-jupyterbook-latex is a Sphinx extension designed to enhance LaTeX output for Jupyter Book projects. It intercepts the LaTeX build process and applies a series of AST transforms to restructure documents for better PDF generation, including setting the LaTeX engine to xelatex, configuring a custom theme, and optionally managing image conversion and table-of-contents formatting.

The extension does not provide its own LaTeX theme but instead modifies Sphinx's LaTeX builder behavior through configuration overrides and document transformations. It is intended for projects that need to generate high-quality PDFs from Jupyter Book sources, particularly when using advanced LaTeX features or complex document structures.

Use it for:

• Generate PDFs from Jupyter Book projects with improved LaTeX formatting and structure.
• Configure xelatex as the LaTeX engine for better Unicode and font support in PDF output.
• Automatically convert images and manage bibliographies in LaTeX-based Jupyter Book builds.
• Create structured PDF documents with part-level headings derived from table-of-contents captions.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx extension that adds LaTeX output infrastructure for Jupyter Book, configuring LaTeX builders and manipulating the document structure for PDF generation.

Yes, if you are actively building Jupyter Book projects that require PDF output and are willing to test against your specific Jupyter Book and Sphinx versions. The extension has low install friction and permissive licensing, but dormant maintenance (977 days since last release) means you should verify compatibility with current dependencies and check whether referenced issues have been resolved elsewhere before relying on it for production workflows.

Install

sphinx-jupyterbook-latex on PyPI

pip install sphinx-jupyterbook-latex

uv add sphinx-jupyterbook-latex

poetry add sphinx-jupyterbook-latex

Installing sphinx-jupyterbook-latex

Before you install

Low install friction with only two runtime dependencies (sphinx and packaging). Dormant maintenance status since 977 days after last release; no active development signals.

License in practice

BSD License (permissive); no restrictions on use, modification, or distribution in commercial or private projects.

Quickstart

pip install sphinx-jupyterbook-latex

# In Sphinx conf.py:
extensions = ["sphinx_jupyterbook_latex"]

# Or in Jupyter Book config.yml:
sphinx:
  extra_extensions:
    - sphinx_jupyterbook_latex

Requires Python 3.9 or later and an existing Sphinx or Jupyter Book project to configure.

Verify before relying

• Whether the extension works with current Jupyter Book and Sphinx versions released after 2023-12-11.
• Status of the referenced GitHub issues (executablebooks/meta#169) and whether they remain unresolved.
• Whether xelatex and other LaTeX system dependencies are automatically handled or must be installed separately.

Package facts

Evidence: sphinx_jupyterbook_latex-1.0.0-py3-none-any.whl

Tags

More Sphinx packages