Static site generator for jupyter notebooks
jpy-flette is a lightweight (~150 lines) python static website generator which uses jupyter notebooks as input. It’s fantastic for documenting scientific projects, documentation, or just to share your thoughts with the world.
Install jpy-flette with pip:
pip install jpy-flette
You could also download or clone the source code from the repository, then run
python setup.py install
Make sure you check the documentation, which is actually built using jpy-flette itself!
jpy-flette transforms a directory full of .ipynb jupyter notebooks into a website with multiple pages. Let’s assume the following directory structure:
~/my/directory └── notebooks ├── 00.index.ipynb └── 01.jpy-flette-documentation.ipynb
you would obtain
~/my/directory ├── docs │ ├── index.html │ ├── jpy-flette-documentation.html │ └── static │ ├── style.css │ └── script.js └── notebooks ├── 00.index.ipynb └── 01.jpy-flette-documentation.ipynb
~/my/directory/docs is then ready to be published!
jpy-flette can be configured using fletteconf.yaml files for theming, titles/footers and more. Refer the documentation for more.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|jpy_flette-0.1.0-py3-none-any.whl (57.1 kB) Copy SHA256 hash SHA256||Wheel||py3|
|jpy_flette-0.1.0.tar.gz (55.3 kB) Copy SHA256 hash SHA256||Source||None|