Skip to main content

A clean book theme for scientific explanations and documentation with Sphinx

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


Release history Release notifications | RSS feed

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

Uploaded Source

Built Distribution

sphinx_book_theme-1.1.4-py3-none-any.whl (434.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_book_theme-1.1.4.tar.gz
  • Upload date:
  • Size: 439.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for sphinx_book_theme-1.1.4.tar.gz
Algorithm Hash digest
SHA256 73efe28af871d0a89bd05856d300e61edce0d5b2fbb7984e84454be0fedfe9ed
MD5 31898c128bb5a711039afb2d3eb8d645
BLAKE2b-256 4519d002ed96bdc7738c15847c730e1e88282d738263deac705d5713b4d8fa94

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_book_theme-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 843b3f5c8684640f4a2d01abd298beb66452d1b2394cd9ef5be5ebd5640ea0e1
MD5 e10d937bc9a1bf248f7736e85a583abd
BLAKE2b-256 519ec41d68be04eef5b6202b468e0f90faf0c469f3a03353f2a218fd78279710

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page