Metadata-Version: 2.1
Name: sphinx-book-theme
Version: 0.0.19
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
Description: # 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.
        
Keywords: reproducible science environments scholarship notebook
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: sphinx
Provides-Extra: code_style
Provides-Extra: testing
