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

This version

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

Uploaded Source

Built Distribution

sphinx_book_theme-1.0.1-py3-none-any.whl (396.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_book_theme-1.0.1.tar.gz
  • Upload date:
  • Size: 290.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for sphinx_book_theme-1.0.1.tar.gz
Algorithm Hash digest
SHA256 927b399a6906be067e49c11ef1a87472f1b1964075c9eea30fb82c64b20aedee
MD5 6c7d28655023c49c9e9079ee43b2ca30
BLAKE2b-256 be3d81b2d643d456e3d1bf9069836af7cc32c71e7efaa14faa5858100c9241d7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_book_theme-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d15f8248b3718a9a6be0ba617a32d1591f9fa39c614469bface777ba06a73b75
MD5 0db1996065c2a0637bd1218022f6f548
BLAKE2b-256 8e453abe359075154f4d6a8626f4b591a28cc703d7c169cef1f7b87cab1a62f7

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