Skip to main content

A clean book theme for scientific explanations and documentation with Sphinx

Project description


codecov Documentation Status PyPI

An interactive book theme for Sphinx.

This is a lightweight Sphinx theme designed to mimic the look-and-feel of an interactive book. It has the following primary features:

  • Bootstrap 5 for visual elements and functionality.
  • Flexible content layout that is inspired by beautiful online books, such as the Edward Tufte CSS guide
  • Visual classes designed for Jupyter Notebooks. Cell inputs, outputs, and interactive functionality are all supported.
  • Launch buttons for online interactivity. For pages that are built with computational material, connect your site to an online BinderHub for interactive content.

Get started

To get started with sphinx-book-theme, first install it with pip:

pip install sphinx-book-theme

then, activate the theme in your Sphinx configuration (

html_theme = "sphinx_book_theme"

This will activate the Sphinx Book Theme for your documentation. Note that you may need to change your html_theme_options configuration depending on your previous theme. See the pages to the left for information about what you can configure with sphinx-book-theme.


See the Sphinx Book Theme documentation for more information.

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_book_theme-1.1.2.tar.gz (292.8 kB view hashes)

Uploaded Source

Built Distribution

sphinx_book_theme-1.1.2-py3-none-any.whl (400.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page