A clean book theme for scientific explanations and documentation with Sphinx
Project Links
Meta
Author: Executable Books
Requires Python: >=3.6
Classifiers
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 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.
1.1.4
Feb 20, 2025
1.1.3
Jun 12, 2024
1.1.2
Feb 13, 2024
1.1.1
Feb 13, 2024
1.1.0
Dec 19, 2023
1.1.0rc3
Dec 14, 2023
1.1.0rc2
Dec 14, 2023
1.1.0rc1
Nov 30, 2023
1.0.1
Mar 31, 2023
1.0.0
Mar 01, 2023
1.0.0rc3
Feb 27, 2023
1.0.0rc2
Feb 20, 2023
1.0.0rc1
Feb 19, 2023
0.4.0rc1
Jan 05, 2023
0.3.3
Jul 17, 2022
0.3.2
Mar 29, 2022
0.3.1
Mar 27, 2022
0.3.0
Mar 25, 2022
0.3.0rc2
Mar 17, 2022
0.3.0rc1
Feb 25, 2022
0.2.0
Jan 15, 2022
0.1.10
Jan 10, 2022
0.1.9
Jan 05, 2022
0.1.8
Jan 04, 2022
0.1.7
Nov 11, 2021
0.1.6
Oct 16, 2021
0.1.5
Sep 23, 2021
0.1.4
Sep 20, 2021
0.1.3
Aug 25, 2021
0.1.2
Aug 06, 2021
0.1.1
Jul 20, 2021
0.1.0
Apr 22, 2021
0.0.42
Mar 13, 2021
0.0.41
Mar 09, 2021
0.0.40
Feb 27, 2021
0.0.39
Nov 08, 2020
0.0.39b1
Oct 13, 2020
0.0.38
Oct 07, 2020
0.0.37
Sep 28, 2020
0.0.36
Aug 25, 2020
0.0.35
Aug 10, 2020
0.0.34
Aug 05, 2020
0.0.33
Jul 29, 2020
0.0.32
Jul 22, 2020
0.0.31
Jul 14, 2020
0.0.30
Jul 05, 2020
0.0.29
Jul 03, 2020
0.0.28
Jun 24, 2020
0.0.27
Jun 21, 2020
0.0.26
Jun 21, 2020
0.0.25
Jun 20, 2020
0.0.24
Jun 16, 2020
0.0.23
Jun 11, 2020
0.0.22
Jun 09, 2020
0.0.21
Jun 02, 2020
0.0.20
Jun 01, 2020
0.0.19
May 29, 2020
0.0.18
May 26, 2020
0.0.17
May 20, 2020
0.0.16
May 15, 2020
0.0.15
May 14, 2020
0.0.14
May 14, 2020
0.0.13
May 13, 2020
0.0.12
May 08, 2020
0.0.11
May 05, 2020
0.0.10
May 01, 2020
0.0.9
May 01, 2020
0.0.8
Apr 30, 2020
0.0.7
Apr 28, 2020
0.0.6
Apr 28, 2020
0.0.5
Apr 25, 2020
0.0.4
Apr 24, 2020
0.0.3
Apr 23, 2020
0.0.2
Apr 22, 2020
0.0.1
Apr 22, 2020
