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.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c462cacc720f39968218bc3de291f8065c67a8c74ab4dc7ff4c118136b3f922 |
|
MD5 | 1e4c2db76a72c3f0dd6b4277da56d524 |
|
BLAKE2b-256 | 9892304c3fb2416571624d905fcea6d76c250f2942aed3a307c690296c9bac74 |
Hashes for sphinx_jupyterbook_latex-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27fd4c10f774ffe65e39a11a9bbac62448f02c1cf0e5bf53c3ed5db167002390 |
|
MD5 | 8f55b297aad4ede4223669fabe1e9acb |
|
BLAKE2b-256 | 5775e722c65c69661786681d55b3287020c904b6b8cd5dcc257867af7cb58338 |