Metadata-Version: 2.1
Name: nb-pdf-template
Version: 2.0.2
Summary: LaTeX templates for jupyter notebook conversion to pdf
Home-page: https://github.com/t-makaro/nb_pdf_template
Author: Tyler Makaro
Author-email: 
License: MIT
Description: # 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.
        
        ## 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)
        3. **BOXES!** are drawn around code cells.
        4. In/Out will move to the left as the execution count increases instead of pushing code to the right.
        5. ~~$\LaTeX$ and $\Tex$ in markdown cells will no longer cause conversion to fail~~ **(This change was merged into nbconvert and is set for 5.4.0 release)**
        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 text colours updated to match Jupyter
        8. Markdown paragraphs are no longer auto-indented in the pdf
        9. Syntax highlighting improvements. (Bonus if using XeLaTeX)
        10. Raw pyout text wrapping improvements.
        11. Code cell text wrapping (requires extra setup)
        
        Quick Comparison:
        ![comparison](example/comparison.png)
        for a closer look see the example directory.
        
        ## Installation
        
        ### Manually:
        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
        
        ### Automatically:
        This has been thoroughly tested on windows, and it has been reported to work on MacOS as well.
        ```
        pip install nb_pdf_template
        python -m nb_pdf_template.install
        ```
        
        ### Optional Extra Setup
        In order to make code cells wrap text, we need to change how nbconvert does syntax highlighting. This feature is experimental. (And known not to work with TeX Live 2015).
        
        Add the following to your ```jupyter_nbconvert_config.py``` and your ```jupyter_notebook_config.py```:
        ```
        c.PDFExporter.latex_command = ['xelatex', '-8bit', '-shell-escape','{filename}']
        ```
        then run:
        ```
        python -m nb_pdf_template.install --minted
        ```
        
        ## Use
        From the command line:
        ```
        jupyter nbconvert --to pdf filename.ipynb --template classicm
        ```
        
        Adding:
        ```
        c.LatexExporter.template_file = 'classicm'
        ```
        to the ```jupyter_nbconvert_config.py``` file will let you drop the "--template classicm", and to the ```jupyter_notebook_config.py``` file will let you use "download as pdf" from within the Jupyter notebook.
        
        Replace ```classicm``` with your template of choice.
        
        ### Templates
        This package offers the following templates:
        
        Template | Use
        ---------|-------
        classic.tplx | For most accurate recreation of the default Jupyter Notebook Style.
        classicm.tplx **(Recommended)**| 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.
        style_jupyter.tplx | DO NOT use this directly. Inherit from this template if you want to build your own.
        
        ## Todo
        [Moved to the wiki](https://github.com/t-makaro/nb_pdf_template/wiki/Todo-List)
        
        ## Tips (Good for any template)
        [Moved to the wiki](https://github.com/t-makaro/nb_pdf_template/wiki/Tips)
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Text Processing :: Markup :: LaTeX
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
