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.0rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1cccbf81dd3541054716e76793c8f61a3a5b97561166acc007edbb083ee8bc0e |
|
MD5 | a0f7b61090e3e8e4a121dbb1f05f6027 |
|
BLAKE2b-256 | 4395ac3a5f3274b0aaba2c494a85fd2192a76fdc4a056c6e5c8ae03e563c6eb2 |
Hashes for sphinx_book_theme-1.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b68cf85cde9ff9fd4cca95fb9a81739052886c20e849fb6643ae8fb2271104f |
|
MD5 | caf793e2bff51fd28443f6e7d9c5ecc9 |
|
BLAKE2b-256 | 7526a4cdcb7b77003da53b3b7540763875c9f477258145f73505b6ff9326e8f1 |