Added the README
This commit is contained in:
commit
8c4e555bc7
1 changed files with 15 additions and 0 deletions
15
README.md
Normal file
15
README.md
Normal file
|
|
@ -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.
|
||||
Loading…
Add table
Add a link
Reference in a new issue