/Spyrkle

Static documentation for your glorious pythonic work

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Spyrkle

Static documentation is great because it never changes, it can be archived and sent to collegues. There's no better way to keep a clean record of your amazing experiments and results.

Current version allows you to create paginated notebooks containing images (from urls), code and graphs (like Deep Learning models from pyTorch for example). In the future I may add support for static images and plots, and embedding in Jupyter notebooks.

Contributions welcome!

Installation

  • Clone it
  • Go into the Spyrkle folder
  • Do python setup.py develop

As always it is highly recommended to install Spyrkle inside a virtual environement. Use conda, it's better.