Latex specific features for jupyter book
Project description
sphinx-jupyterbook-latex
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 conf.py
:
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:
extra_extensions:
- 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:
- 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 sphinx_jupyterbook_latex-0.4.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06d6c15f5ee572d4852421fb9e94ed1dcfd0ff68e03eb0ba61c2829b8114ac8e |
|
MD5 | 583cfc853346c34b448fe936a7268ba7 |
|
BLAKE2b-256 | 84a639c69c1d87a5f0e2695de90265e88995c5823c50fee3901f2e98e0713c88 |
Hashes for sphinx_jupyterbook_latex-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f88bb6467fbebd25518b0bd3b060103774b1297cf43a3a81ae8b30b632ea3b94 |
|
MD5 | 256fdbee7a3563c820eaaabc7e6d2f9a |
|
BLAKE2b-256 | a6f536102e7ee503ba8f4f59e769e058e354b164d2b6dcd2a502b3e354b10ef2 |