A clean book theme for scientific explanations and documentation with Sphinx

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for choldgraf from gravatar.com choldgraf Avatar for ebp-bot from gravatar.com ebp-bot

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD License
  • Maintainer: Chris Holdgraf
  • Requires: Python >=3.7
Classifiers

Project description

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.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for choldgraf from gravatar.com choldgraf Avatar for ebp-bot from gravatar.com ebp-bot

Unverified details

These details have not been verified by PyPI
Meta
  • License: BSD License
  • Maintainer: Chris Holdgraf
  • Requires: Python >=3.7
Classifiers

Release history Release notifications | RSS feed

1.1.3

1.1.2

1.1.1

1.1.0

1.1.0rc3 pre-release

1.1.0rc2 pre-release

1.1.0rc1 pre-release

1.0.1

1.0.0

1.0.0rc3 pre-release

1.0.0rc2 pre-release

1.0.0rc1 pre-release

0.4.0rc1 pre-release

0.3.3

0.3.2

This version

0.3.1

0.3.0

0.3.0rc2 pre-release

0.3.0rc1 pre-release

0.2.0

0.1.10

0.1.9

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.42

0.0.41

0.0.40

0.0.39

0.0.39b1 pre-release

0.0.38

0.0.37

0.0.36

0.0.35

0.0.34

0.0.33

0.0.32

0.0.31

0.0.30

0.0.29

0.0.28

0.0.27

0.0.26

0.0.25

0.0.24

0.0.23

0.0.22

0.0.21

0.0.20

0.0.19

0.0.18

0.0.17

0.0.16

0.0.15

0.0.14

0.0.13

0.0.12

0.0.11

0.0.10

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

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

Uploaded Source

Built Distribution

sphinx_book_theme-0.3.1-py3-none-any.whl (335.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_book_theme-0.3.1.tar.gz
  • Upload date:
  • Size: 269.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.12

File hashes

Hashes for sphinx_book_theme-0.3.1.tar.gz
Algorithm Hash digest
SHA256 3b59b3bcb9a32a56e0bec8786d24cae3923d4c5f1af55544c38ce3e61262dea9
MD5 1a21f771d3371ad8ce996e7216f6e3df
BLAKE2b-256 251d2232a0f5d05f03021a5a050725f0cf66cc3dafb0bd6273a8f9584772d153

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_book_theme-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 335.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.12

File hashes

Hashes for sphinx_book_theme-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 31755ba7703a8d0841862ad3c56d8856bf4173d40ef71e116b758ae495c772a1
MD5 a57d7d8dfcec448427db80026b0cc479
BLAKE2b-256 9fc270868e57306df8927b49b7e4495ff370aa361ba3366769eacc019def771d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page