Books with Jupyter¶

Jupyter Book is an open source project for building beautiful, publication-quality books and documents from computational material.

Here are some of the features of Jupyter Book:

This website is built with Jupyter Book! You can browse its contents to the left to see what is possible.

Get involved with Jupyter Book! Jupyter Book is an open community that welcomes your feedback, input, and contributions! Open an issue to provide feedback and new ideas, and to help others. Vote for new features by adding a 👍 to issues you’d like to see completed. Contribute to Jupyter Book by following our contributing guidelines and finding an issue to work on. See the feature voting leaderboard for inspiration.

Get started¶ To get started with Jupyter Book, you can either check out the getting started guide,

browse the contents of the navigation menu of this book (to the left, if you’re on a laptop), or

review the example project shown immediately below (if you like learning from examples). Warning Jupyter Book 0.7 is a total re-write from 0.6 , and some things have changed. See the legacy upgrade guide for how to upgrade, and legacy.jupyterbook.org for legacy documentation. In addition, note that Jupyter Book is pre-1.0. Its API may change! To install the jupyter-book pre-release from pip, run the following command: pip install -U jupyter-book

Under the hood - the components of Jupyter Book¶ Jupyter Book is a wrapper around a collection of tools in the Python ecosystem that make it easier to publish computational documents. Here are a few key pieces: It uses the MyST markdown language in markdown and notebook documents. This allows users to write rich, publication-quality markup in their documents.

It uses the MyST-NB package to parse and read-in notebooks so they are built into your book.

It uses the Sphinx documentation engine to build outputs from your book’s content.

It uses a slightly modified version of the PyData Sphinx theme for beautiful HTML output.

It uses a collection of Sphinx plugins and tools to add new functionality. For more information about the project behind many of these tools, see The Executable Book Project documentation.