jupyterlite-sphinx

A Sphinx extension that provides utilities for embedding JupyterLite in your docs.

jupyterlite-sphinx brings the power of JupyterLite to your Sphinx documentation. It makes a full JupyterLite deployment in your docs and provide some utilities for using that deployment easily.

• Installation
• Configuration
  • JupyterLite content
  • JupyterLite dir
  • Pre-installed packages
  • JupyterLite config
  • Strip particular tagged cells from IPython Notebooks
  • Disable the .ipynb docs source binding
  • Additional CLI arguments for jupyter lite build

Usage

jupyterlite-sphinx provides a collection of directives that allows you to embed the different JupyterLite UIs directly in your documentation page. Each of those directives can be configured with the following options:

• width (default "100%") the width of the UI

• height (default "600px") the height of the UI

• theme (default None) the JupyterLab theme to use

• prompt (default False) whether or not to lazy-load the UI. If the value is a string, it will use this value for the prompt button.

• prompt_color (default #f7dc1e) The color of the prompt button, if there is one.

• JupyterLite directive
• NotebookLite directive
• Replite directive
• Voici directive
• TryExamples directive
  • Examples
  • Configuration
  • Other considerations
• Fullscreen access
  • custom link to JupyterLite
• Changelog
  • 0.16.5
  • 0.16.4
  • 0.16.3
  • 0.16.2
  • 0.16.1
  • 0.16.0
  • 0.15.0
  • 0.14.0
  • 0.13.1
  • 0.13.0
  • 0.12.0
  • 0.11.0
  • 0.10.0
  • 0.9.3
  • 0.9.2
  • 0.9.1
  • 0.9.0
  • 0.8.0
  • 0.7.3
  • 0.7.2
  • 0.7.1
  • 0.7.0
  • 0.6.0
  • 0.5.0
  • 0.4.9
  • 0.4.8
  • 0.4.7
  • 0.4.6
  • 0.4.5
  • 0.4.4
  • 0.4.3
  • 0.4.2
  • 0.4.1
  • 0.4.0
  • 0.3.0
  • 0.2.0