markdown-body entry-content container-lg" itemprop="text">

sphinx-book-theme

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 (conf.py):

...
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.

Documentation

See the Sphinx Book Theme documentation for more information.

License

executablebooks/sphinx-book-theme

About

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases 71

Used by 5.2k

Contributors 63

Languages