From 8c4e555bc776742fc212cd92965128ce787ee046 Mon Sep 17 00:00:00 2001 From: releng bot Date: Fri, 12 Dec 2025 21:20:55 +0000 Subject: [PATCH] Added the README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..32d545c --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# python-sphinx-book-theme + +[Sphinx-book-theme](https://github.com/executablebooks/sphinx-book-theme) is a +lightweight [Sphinx](https://www.sphinx-doc.org/) theme designed to mimic the +look-and-feel of an interactive book. It has the following primary features: + +- [Bootstrap 5](https://getbootstrap.com/) 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](https://jupyter.org/). 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](https://binderhub.readthedocs.io/) for interactive content. \ No newline at end of file