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
Project links
Meta
  • License: BSD License (BSD 3-Clause License Copyright (c) 2020, Chris Holdgraf All rights reserved. Redistribution and us...)
  • Maintainer: Executable Books Team
  • Requires: Python >=3.9
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 5 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
Project links
Meta
  • License: BSD License (BSD 3-Clause License Copyright (c) 2020, Chris Holdgraf All rights reserved. Redistribution and us...)
  • Maintainer: Executable Books Team
  • Requires: Python >=3.9
Classifiers

Release history Release notifications | RSS feed

This version

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

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

Uploaded Source

Built Distribution

sphinx_book_theme-1.1.3-py3-none-any.whl (430.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_book_theme-1.1.3.tar.gz
  • Upload date:
  • Size: 434.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for sphinx_book_theme-1.1.3.tar.gz
Algorithm Hash digest
SHA256 1f25483b1846cb3d353a6bc61b3b45b031f4acf845665d7da90e01ae0aef5b4d
MD5 8b5ea55eed06201896c9dd716c07a0d6
BLAKE2b-256 896961dfa3b3851610b5f45960737bd99f8c5b2d70ba73f9ac84a527e0c564ae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_book_theme-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a554a9a7ac3881979a87a2b10f633aa2a5706e72218a10f71be38b3c9e831ae9
MD5 16cd918af0dddb10a31ba4e48aef66d1
BLAKE2b-256 2b8090574e2e82c955b9c6f6b77f7badb2cf2ef4ef77599e4343cced2d098681

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