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.1.0rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a23dca61acc304b7810c46e0a01214e5fcac19b8f99a40ed5646e85e4fa1f06 |
|
MD5 | 2f8fa2461cc68cb7a920f8c52de98142 |
|
BLAKE2b-256 | 58c048a93cf531519bb43bfd4640a03157a635c3ad846e52f11ae8f117c43949 |
Hashes for sphinx_book_theme-1.1.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2fcf214cd88e0a0db0409d03285c3bb1e4cb24c043ab263e0cda20f1dedbcb3a |
|
MD5 | f4deac447f275a0ee4e1b30bab752ef2 |
|
BLAKE2b-256 | b965d7263f269bcb8e0d45dbf0a838e99b549ecb9371c56dde591caede417a02 |