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.0rc3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac3410d75b62efd8f1d6b588e8e9e7a35bb9453ebd8a3b0bd77f73389ad4bbf3 |
|
MD5 | da90ecb119c73969f77b05b5632c9898 |
|
BLAKE2b-256 | 05fcdf2a658161d367a81b6b4a3efb9b066d028c0e282249f8aa6186b2aedba8 |
Hashes for sphinx_book_theme-1.1.0rc3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67704a962fe3c1344e4e0501994a397f9f9055f36d4436e0b85b8ed09021723a |
|
MD5 | 9977f6ae21eb566bd72fc13d1e3e5f1d |
|
BLAKE2b-256 | 7c95ef9f94f895bca8669693e6c1496cee33e6ce0083603542e7ddbbd5b292ac |