Latex specific features for jupyter book
Project description
jupyterbook-latex [IN DEVELOPMENT]
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 jupyterbook-latex
, first install it through pip
:
pip install jupyterbook-latex
then, add jupyterbook_latex
to your extensions,
in a Sphinx conf.py
:
extensions = ["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:
extra_extensions:
- 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:
- Overrides some configuration:
latex_engine
->xelatex
latex_theme
->jupyterBook
- appends necessary LaTeX commands to the preamble
- When a latex builder is specified:
- Set's up
sphinx.ext.imgconverter
(ifjblatex_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
Issues
A list of issues that need to be addressed:
https://github.com/executablebooks/meta/issues/169
Developer Notes
A repository that contains many different project configurations for testing and development is available, along with implementation idea and notes
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyterbook_latex-0.2.1a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dde3117d1410a4d3d231ea046ac005d554aa43de09c62d7e117b5e9952d18f1b |
|
MD5 | ff94f4705e672869e12747817eed3670 |
|
BLAKE2b-256 | 67b15a987d1680a3e10be75dd0c4292c8f1d3c77a604f16a22aece34d359b6a0 |
Hashes for jupyterbook_latex-0.2.1a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22de52c94c168b7ce223dd27a644c40432877bfa98a02971ea340603b7aff643 |
|
MD5 | 04fdea48ea5c6d1c2612b71891cc161f |
|
BLAKE2b-256 | 393db7301061c31e6933a640fabd73079edcf90bbdbd710e095a28bafa0c1586 |