The Sphinx Book Theme

badge-url 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:

See also

This is the default theme in Jupyter Book.

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.

Acknowledgements

This theme is heavily inspired by (and dependent on) PyData Sphinx Theme for its base structure and configuration.