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.0rc3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebf855c04d21e5aea0473b5706549cefeb66d8b3631261a1584807d844c045b2 |
|
MD5 | cb339111c15e0f749622b6424d6ae46f |
|
BLAKE2b-256 | 7691c858ed13308afafdbce1f6bb068667436e4b555709274693dbf971b62718 |
Hashes for sphinx_book_theme-1.0.0rc3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2c1c21e1142346ee2a3b3e22f5f88127aa185f4a4bdeafa1ccfdd7bc5eb6900 |
|
MD5 | 2461067e9920d8e1c1fc9fd0c6848031 |
|
BLAKE2b-256 | 9f31359d9d2c25f549f33328da87dfb26797dfcb1ee8fe6a14710b4342fa37d4 |