voila-nbgallery 0.0.3

Voila templates for nbgallery project

voila-nbgallery

Experimental work in progress - subject to change!

This project contains Voila templates to use in offline scenarios and/or in conjunction with nbgallery. These templates use jinja template inheritance to build on top of upstream templates maintained by the Voila project.

Templates in this package

• offline-lab - Voila's default template, patched to work offline (nothing nbgallery-specific)
  • Patch for using Qgrid in conjunction with enable_nbextensions=True (voila#72)
  • Local copy of font-awesome stylesheet (voila#539)
• offline-gridstack - voila-gridstack template, patched to work offline (nothing nbgallery-specific)
  • Qgrid and font-awesome patches as above
  • Local copy of gridstack javascript and stylesheet (voila-gridstack#26)
• nbgallery-material - Prototype nbgallery template based on voila-material
  • Qgrid and font-awesome patches as above
  • Workaround for javascript widget error (voila-material#22)
  • Displays nbgallery metadata if present in the notebook
    • Note: prototype only; nbgallery doesn't currently populate all the fields used by the template.
  • Sets the nbgallery notebook and revision id as environment variables in the kernel - this can be used for provenance of external actions taken by the notebook
    • Note: this only works if Voila is running as a server extention; in standalone mode, execute requests are blocked.

See the notebooks directory for some examples.

Installation

If you plan to use only the offline-lab or nbgallery-material template:

pip install voila-nbgallery

We've listed voila-gridstack as an optional dependency because it includes UI extensions for both Jupyter Lab and Jupyter Notebook, and you may not want those if you're not using the gridstack template. If you plan to use the offline-gridstack template, then install with the optional dependency:

pip install voila-nbgallery[gridstack]