https://github.com/executablebooks/sphinx-book-theme
A clean book theme for scientific explanations and documentation with Sphinx
https://github.com/executablebooks/sphinx-book-theme
sphinx-theme
Last synced: about 2 months ago
JSON representation
A clean book theme for scientific explanations and documentation with Sphinx
- Host: GitHub
- URL: https://github.com/executablebooks/sphinx-book-theme
- Owner: executablebooks
- License: bsd-3-clause
- Created: 2020-03-02T23:20:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T16:37:27.000Z (7 months ago)
- Last Synced: 2024-10-22T05:18:51.614Z (7 months ago)
- Topics: sphinx-theme
- Language: Jupyter Notebook
- Homepage: https://sphinx-book-theme.readthedocs.io
- Size: 2.51 MB
- Stars: 436
- Watchers: 13
- Forks: 200
- Open Issues: 105
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# sphinx-book-theme
[![codecov][codecov-badge]][codecov-link] [![Documentation Status][rtd-badge]][rtd-link] [![PyPI][pypi-badge]][pypi-link]
**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](https://edwardtufte.github.io/tufte-css/)
* **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](https://sphinx-book-theme.readthedocs.io/en/latest/)
for more information.
[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-book-theme/branch/master/graph/badge.svg
[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-book-theme
[rtd-badge]: https://readthedocs.org/projects/sphinx-book-theme/badge/?version=latest
[rtd-link]: https://sphinx-book-theme.readthedocs.io/en/latest/?badge=latest
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-book-theme.svg
[pypi-link]: https://pypi.org/project/sphinx-book-theme