Metadata-Version: 2.4
Name: sphinx-book-theme
Version: 1.1.4
Summary: A clean book theme for scientific explanations and documentation with Sphinx
Maintainer-email: Executable Books Team <executablebooks@gmail.com>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
License-File: LICENSE
Requires-Dist: sphinx>=5.3
Requires-Dist: pydata-sphinx-theme>=0.15.4
Requires-Dist: pre-commit ; extra == "code-style"
Requires-Dist: ablog ; extra == "doc"
Requires-Dist: ipywidgets ; extra == "doc"
Requires-Dist: folium ; extra == "doc"
Requires-Dist: numpy ; extra == "doc"
Requires-Dist: matplotlib ; extra == "doc"
Requires-Dist: numpydoc ; extra == "doc"
Requires-Dist: myst-nb ; extra == "doc"
Requires-Dist: nbclient ; extra == "doc"
Requires-Dist: pandas ; extra == "doc"
Requires-Dist: plotly ; extra == "doc"
Requires-Dist: sphinx-design ; extra == "doc"
Requires-Dist: sphinx-examples ; extra == "doc"
Requires-Dist: sphinx-copybutton ; extra == "doc"
Requires-Dist: sphinx-tabs ; extra == "doc"
Requires-Dist: sphinx-togglebutton ; extra == "doc"
Requires-Dist: sphinx-thebe ; extra == "doc"
Requires-Dist: sphinxcontrib-bibtex ; extra == "doc"
Requires-Dist: sphinxcontrib-youtube ; extra == "doc"
Requires-Dist: sphinxext-opengraph ; extra == "doc"
Requires-Dist: beautifulsoup4 ; extra == "test"
Requires-Dist: coverage ; extra == "test"
Requires-Dist: defusedxml ; extra == "test"
Requires-Dist: myst-nb ; extra == "test"
Requires-Dist: pytest ; extra == "test"
Requires-Dist: pytest-cov ; extra == "test"
Requires-Dist: pytest-regressions ; extra == "test"
Requires-Dist: sphinx_thebe ; extra == "test"
Project-URL: Documentation, https://sphinx-book-theme.readthedocs.io/
Project-URL: Repository, https://github.com/executablebooks/sphinx-book-theme
Provides-Extra: code-style
Provides-Extra: doc
Provides-Extra: test

# 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

