A clean book theme for scientific explanations and documentation with Sphinx
Project description
sphinx-book-theme
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
Built Distribution
Hashes for sphinx_book_theme-1.0.0rc2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d2f71a8e34f84d631917523d69e12f099337e7840712d4db7480ac2821c4e97 |
|
MD5 | d171a281e1f0e5de2a151ee41addd01f |
|
BLAKE2b-256 | 482e236c2a9001257449bb4057c7014853d59436f9d1c52f729bbbb99c730052 |
Hashes for sphinx_book_theme-1.0.0rc2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43977402f55b79706e117c6de6f50e67dac6dad698eb9b75be07dc2e6a689bde |
|
MD5 | c845ae1d1a3d1998098c8f6fe686a48c |
|
BLAKE2b-256 | 3426a36763249a0afe2d35ee15265942c7bc6ab347d4f084b067d15ece3486d1 |