executablebooks / sphinx-jupyter-book-theme

An experimental Sphinx theme for Jupyter Book

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

sphinx-jupyter-book-theme

✨✨EXPERIMENTAL✨✨

This is an experimental theme to try replicating the general Jupyter Book theme (jupyterbook.org) using Bootstrap and Sphinx as a build engine. It will evolve rapidly and is not guaranteed to remain stable (or to exist at all!)

It is heavily inspired from the pydata sphinx bootstrap theme: https://github.com/pandas-dev/pydata-bootstrap-sphinx-theme and uses nbsphinx to read in notebooks to Sphinx.

Installation

pip install -e .

and then

cd docs/make html

About

An experimental Sphinx theme for Jupyter Book

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:HTML 46.3%Language:CSS 27.2%Language:Python 26.5%