Jupman

A template for online books made with Jupyter notebooks and NBSphinx doc generator.

DOWNLOAD:    PDF    EPUB    HTML    Github

Features

• inherits generation of static websites from NBSphinx, with search, PDF, EPUB

• builds with ReadTheDocs, Github Actions, or local Docker emulating ReadTheDocs

• exercises generation from solution templates (both .ipynb and .py)

• zips chapters

• code sharing among chapters (so students don’t need to install dependencies)

• Python Tutor integration (offline, no required dependencies)

• supports hundreds pages and deep nesting

• decent PDF layout

• basic exam management

• optional softpython theme

• documentation and tests

• Apache License v2.0, open source code on Github

Currently lacking

• generated PDF always displays solutions

• Python Tutor doesn’t work in JupyterLab

• more testing for exam management

Requirements

• Python 3.7+

• based upon sphinx-rtd-theme (adds only minimal improvements for better browsing)

Used by

• SoftPython book: english | italian (both 1000+ pdf pages from jupyter notebooks)

• Scientific Programming Lab @ University of Trento, Data Science Master (english, many python exercises and exams in mixed jupyter + python format)

Contents

1. Quickstart

2. Editing worksheets

3. Customize

4. Exams management

5. Chapter examples

   1. Python example

   2. Jupyter example

   3. Mixed jupyter and python example

   4. Challenges:   example worksheet    solution

6. Templates

   1. Past exams

   2. Changelog

7. Tests

   1. Rendering tests

   2. Python Tutor tests

Revisions

• 19 September 2022: Released v3.5.6

• 4 June 2022: Released v3.5

• 30 April 2022: Released v3.4

• 22 February 2022: Released v3.3

• 16 October 2020: Released v3.2

• 16 January 2020: Released v3.1

• 29 December 2019: Released v3.0

• 24 September 2018: Released v2.0

• 3 August 2018: Released v0.8

• Change log

Credits

• This site was made with Jupyter using NBSphinx extension and Jupman template.