A clean book theme for scientific explanations and documentation with Sphinx

These details have not been verified by PyPI

Project description

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.

Project details

These details have not been verified by PyPI

Development Status
- 4 - Beta
Framework
- Sphinx
- Sphinx :: Theme
License
- OSI Approved :: BSD License
Operating System
- OS Independent
Programming Language
- Python :: 3

Release history Release notifications | RSS feed

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 pre-release

Dec 14, 2023

1.1.0rc2 pre-release

Dec 14, 2023

1.1.0rc1 pre-release

Nov 30, 2023

1.0.1

Mar 31, 2023

1.0.0

Mar 1, 2023

1.0.0rc3 pre-release

Feb 27, 2023

1.0.0rc2 pre-release

Feb 20, 2023

1.0.0rc1 pre-release

Feb 19, 2023

0.4.0rc1 pre-release

Jan 5, 2023

This version

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 pre-release

Mar 17, 2022

0.3.0rc1 pre-release

Feb 25, 2022

0.2.0

Jan 15, 2022

0.1.10

Jan 10, 2022

0.1.9

Jan 5, 2022

0.1.8

Jan 4, 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 6, 2021

0.1.1

Jul 20, 2021

0.1.0

Apr 22, 2021

0.0.42

Mar 13, 2021

0.0.41

Mar 9, 2021

0.0.40

Feb 27, 2021

0.0.39

Nov 8, 2020

0.0.39b1 pre-release

Oct 13, 2020

0.0.38

Oct 7, 2020

0.0.37

Sep 28, 2020

0.0.36

Aug 25, 2020

0.0.35

Aug 10, 2020

0.0.34

Aug 5, 2020

0.0.33

Jul 29, 2020

0.0.32

Jul 22, 2020

0.0.31

Jul 14, 2020

0.0.30

Jul 5, 2020

0.0.29

Jul 3, 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 9, 2020

0.0.21

Jun 2, 2020

0.0.20

Jun 1, 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 8, 2020

0.0.11

May 5, 2020

0.0.10

May 1, 2020

0.0.9

May 1, 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

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-0.3.3.tar.gz (273.9 kB view details)

Uploaded Jul 17, 2022 Source

Built Distribution

sphinx_book_theme-0.3.3-py3-none-any.whl (345.7 kB view details)

Uploaded Jul 17, 2022 Python 3

File details

Details for the file sphinx_book_theme-0.3.3.tar.gz.

File metadata

Download URL: sphinx_book_theme-0.3.3.tar.gz
Upload date: Jul 17, 2022
Size: 273.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for sphinx_book_theme-0.3.3.tar.gz
Algorithm	Hash digest
SHA256	`0ec36208ff14c6d6bf8aee1f1f8268e0c6e2bfa3cef6e41143312b25275a6217`
MD5	`2b5aba4a58c35cdc950f9113838265e8`
BLAKE2b-256	`7ce76cad0c4e1f6565bfbd5c707c85c1dd4b6fa45e1af0bcdb1958fd0c11535d`

See more details on using hashes here.

File details

Details for the file sphinx_book_theme-0.3.3-py3-none-any.whl.

File metadata

Download URL: sphinx_book_theme-0.3.3-py3-none-any.whl
Upload date: Jul 17, 2022
Size: 345.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for sphinx_book_theme-0.3.3-py3-none-any.whl
Algorithm	Hash digest
SHA256	`9685959dbbb492af005165ef1b9229fdd5d5431580ac181578beae3b4d012d91`
MD5	`d9aac030848618fdae20f3b64a59ba29`
BLAKE2b-256	`41c6f9540a1b963d396c5186c194c34a0779e06138fbb6b4a28d8b8c3533ec3d`