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 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
Built Distribution
Hashes for sphinx_book_theme-0.3.0rc2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16280b937dd3222e9edd3abb77f3cc7f730623ac0171b557583e76dd7fe7fdab |
|
MD5 | 2b41a729bcbacda295b598cf98651c06 |
|
BLAKE2b-256 | 25add4163f031ff37bff88ddb7fc8e08cbf49e73317188ea17c7dc7178271d12 |
Hashes for sphinx_book_theme-0.3.0rc2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12dd8286793b7e4c34aec6912b6343e1b5988142fb79be42484fa6aa94425d24 |
|
MD5 | f62fe876025bc4564adb934bda3a5ba2 |
|
BLAKE2b-256 | 67b6911196fc84eed2af81a38685adc115f4f7176c015524d15a92574b5f8611 |