Pretty Jupyter

Pretty Jupyter is an easy-to-use package that allows to create beautiful & dynamic reports. Its main features are:

• Visually appealing styles.

• Automatic table of Contents generation.

• Using Python variables in Markdown (aka Jinja Markdown).

• Tabsets: tabs that hold section content inside them.

• Code Folding: Show/Hide code to filter out unnecessary content.

All these features are integrated directly in the output html page, therefore there is no need to have an interpreter running in the backend. This makes the html easily sendable or uploadable to a static website.

The most of the features require a little to no work to get working and greatly improve the quality of the output report, or even the developers comfort when creating the report.

To use Pretty Jupyter, all we need are two commands: install and export.

# install
pip install pretty-jupyter
# export
jupyter nbconvert --to html --template pj /path/to/ipynb/file

Contents

User Documentation

• Getting Started
  • Installation
  • Creating Our First Pretty Notebook
  • Exporting the Notebook
  • Next Steps
• Page Title
• Jinja Markdown
  • Variables with HTML
• Tabset
• Table of Contents
• Code Folding
• Styling
  • Themes
• Custom Template
  • How to Extend
  • Exporting with Custom Template
  • Blocks
  • Examples
• Command-line Interface
  • Notable switches

Credits

• nbconvert: Pretty Jupyter uses nbconvert underhood. Its great extendability allowed this project to be created.

• RMarkdown: RMarkdown served as a great inspiration when making this package.

• ReadTheDocs: This awesome project that allows you to host your documentation for free, improving the repo quality worldwide.