Metadata-Version: 2.1
Name: sphinx-book-theme
Version: 0.0.25
Summary: Jupyter Book: Create an online book with Jupyter Notebooks
Home-page: https://jupyterbook.org/
Author: Project Jupyter Contributors
Author-email: jupyter@googlegroups.com
License: BSD
Project-URL: Documentation, https://jupyterbook.org
Project-URL: Funding, https://jupyter.org/about
Project-URL: Source, https://github.com/jupyter/jupyter-book/
Project-URL: Tracker, https://github.com/jupyter/jupyter-book/issues
Keywords: reproducible science environments scholarship notebook
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pyyaml
Requires-Dist: docutils (>=0.15)
Requires-Dist: sphinx
Requires-Dist: click
Requires-Dist: setuptools
Requires-Dist: libsass
Requires-Dist: pydata-sphinx-theme (~=0.3.0)
Provides-Extra: code_style
Requires-Dist: flake8 (<3.8.0,>=3.7.0) ; extra == 'code_style'
Requires-Dist: black ; extra == 'code_style'
Requires-Dist: pre-commit (==1.17.0) ; extra == 'code_style'
Provides-Extra: sphinx
Requires-Dist: folium ; extra == 'sphinx'
Requires-Dist: numpy ; extra == 'sphinx'
Requires-Dist: matplotlib ; extra == 'sphinx'
Requires-Dist: ipywidgets ; extra == 'sphinx'
Requires-Dist: pandas ; extra == 'sphinx'
Requires-Dist: nbclient ; extra == 'sphinx'
Requires-Dist: myst-parser ; extra == 'sphinx'
Requires-Dist: myst-nb ; extra == 'sphinx'
Requires-Dist: sphinx-togglebutton ; extra == 'sphinx'
Requires-Dist: sphinx-copybutton ; extra == 'sphinx'
Requires-Dist: plotly ; extra == 'sphinx'
Requires-Dist: sphinxcontrib-bibtex ; extra == 'sphinx'
Provides-Extra: testing
Requires-Dist: coverage ; extra == 'testing'
Requires-Dist: pytest (<4,>=3.6) ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: beautifulsoup4 ; extra == 'testing'
Requires-Dist: pytest-regressions ; extra == 'testing'

# sphinx-book-theme

[![codecov](https://codecov.io/gh/executablebooks/sphinx-book-theme/branch/master/graph/badge.svg)](https://codecov.io/gh/executablebooks/sphinx-book-theme) | [![Documentation Status](https://readthedocs.org/projects/sphinx-book-theme/badge/?version=latest)](https://sphinx-book-theme.readthedocs.io/en/latest/?badge=latest)

**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](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.


