Skip to content

A clean book theme for scientific explanations and documentation with Sphinx

License

Notifications You must be signed in to change notification settings

executablebooks/sphinx-book-theme

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a7d9b07 · Nov 24, 2022
Nov 15, 2022
Nov 15, 2022
Nov 24, 2022
Nov 9, 2022
Apr 11, 2020
Jul 15, 2022
Nov 15, 2022
Jan 25, 2022
Jul 15, 2022
Oct 19, 2022
Mar 24, 2022
Mar 2, 2020
Aug 26, 2020
Sep 23, 2020
Jan 25, 2022
Nov 15, 2022
Nov 7, 2022
Sep 12, 2022

Repository files navigation

sphinx-book-theme

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