Skip to main content

Jupyter Book: Create an online book with Jupyter Notebooks

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


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

Uploaded Source

Built Distribution

sphinx_book_theme-0.0.42-py3-none-any.whl (89.5 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-book-theme-0.0.42.tar.gz.

File metadata

  • Download URL: sphinx-book-theme-0.0.42.tar.gz
  • Upload date:
  • Size: 56.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

File hashes

Hashes for sphinx-book-theme-0.0.42.tar.gz
Algorithm Hash digest
SHA256 a67d3ead308eedec048d52d0ef0f958795f432464b9db02d6612a5697bcf9e33
MD5 98d74f81fdf994f76c085ca2247f5eec
BLAKE2b-256 a7ac704a3e5bbf0aab437851ffd6a5ff366e8f5bf797d44d7eb6dd05e9d39975

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_book_theme-0.0.42-py3-none-any.whl
  • Upload date:
  • Size: 89.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.1.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

File hashes

Hashes for sphinx_book_theme-0.0.42-py3-none-any.whl
Algorithm Hash digest
SHA256 ce958d2c6d91573215f0f591bf97c68f722be313e3c0a19983ab571cc642aed3
MD5 dd57a665556ba8749c27bd2f7736d557
BLAKE2b-256 8bda426f72e1c45f0e1394c21a872d2a610370f3950293b35d2ed0d773284b7f

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