Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/t-makaro/nb_pdf_template
A more accurate representation of jupyter notebooks when converting to pdfs.
https://github.com/t-makaro/nb_pdf_template
conversion jupyter jupyter-notebook latex latex-template nbconvert pdf
Last synced: 5 days ago
JSON representation
A more accurate representation of jupyter notebooks when converting to pdfs.
- Host: GitHub
- URL: https://github.com/t-makaro/nb_pdf_template
- Owner: t-makaro
- License: mit
- Created: 2017-10-09T20:14:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-30T21:47:41.000Z (about 5 years ago)
- Last Synced: 2024-09-25T05:03:38.482Z (8 days ago)
- Topics: conversion, jupyter, jupyter-notebook, latex, latex-template, nbconvert, pdf
- Language: Jupyter Notebook
- Size: 1.92 MB
- Stars: 130
- Watchers: 5
- Forks: 25
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# classic.tplx
A more accurate representation of jupyter notebooks when converting to pdfs.
This template was designed to make converted jupyter notebooks look (almost) identical to the actual notebook. If something doesn't exist in the original notebook then it doesn't belong in the conversion.
## Note for nbconvert 5.5.0
As of nbconvert 5.5.0, the majority of these improvements have been merged into nbconvert's default template. Version 3.x of this package will continue to support nbconvert 5.5.0 and lower, whereas in the future version 4.x will only support nbconvert 5.5.0 and newer. Versions 3.x, and 4.x will overlap support for nbconvert version 5.5.0.
## Note for nbconvert 6.0.0
nbconvert 6.0.0 is not yet released, but it will be changing the conversion template in a backward incompatible manner. A version 5.x of this repository will be made to support nbconvert >=6.0.0
## Improvements
1. \maketitle is removed (If you want a title then add a markdown cell to the top of your notebook).
2. Sections are no longer numbered automatically (notebooks don't number sections so the pdf shouldn't).
8. Markdown paragraphs are no longer auto-indented in the pdf.
9. Syntax highlighting improvements. (Bonus if using XeLaTeX)
3. ~~**BOXES!** are drawn around code cells.~~ **(This change was merged into nbconvert 5.5.0)**
4. ~~In/Out counts will move to the left as the execution count increases instead of pushing code to the right (only numbers are displayed by default to save page width).~~ **(This change was merged into nbconvert 5.5.0)**
5. ~~$\LaTeX$ and $\Tex$ in markdown cells will no longer cause conversion to fail.~~ **(This change was merged into nbconvert 5.4.0)**
6. "\LaTeX" and "\TeX" are no longer converted into a logo on conversion to pdf unless they are in math mode. (This and the above point replicate the functionality of these commands in notebook markdown).
7. ~~In/Out prompt colours updated to match Jupyter.~~ **(This change was merged into nbconvert 5.5.0)**
10. ~~Output text wrapping improvements.~~ **(This change was merged into nbconvert 5.5.0)**
11. ~~Code cell text wrapping.~~ **(This change was merged into nbconvert 5.5.0)**
Quick Comparison:
for a closer look see the example directory.
## Installation
```
pip install nb_pdf_template
python -m nb_pdf_template.install
```
### Updating
```
pip install -U nb_pdf_template
python -m nb_pdf_template.install
```
### Manual Install:
Drop all of the "*.tplx" files into the folder containing the other LaTeX nbconvert templates. If using anaconda, it should be something like:
> */Anaconda3/Lib/site-packages/nbconvert/templates/latex
## Use
From the command line:
```bash
jupyter nbconvert --to pdf filename.ipynb --template classic
```
Adding:
```python
c.LatexExporter.template_file = 'classic'
```
to the ```jupyter_nbconvert_config.py``` file will let you drop the "--template classic", and to the ```jupyter_notebook_config.py``` file will let you use "download as pdf" from within the Jupyter notebook.
Replace ```classic``` with your template of choice.
### Templates
This package offers the following templates:
Template | Use
---------|-------
classic.tplx **(Recommended)**| For most accurate recreation of the default Jupyter Notebook style.
classicm.tplx | m for modified. Similar to classic.tplx, but in/out prompts are above cells instead of in the margin. Bonus left margins are smaller so code cells are wider.
## Tips (Good for any template)
[Moved to the wiki](https://github.com/t-makaro/nb_pdf_template/wiki/Tips)