sphinx-juniper

Integrate interactive code blocks into your documentation with Juniper and Binder.

Install

To install sphinx-juniper first clone and install it:

pip install sphinx-juniper

Then, add it to your Jupyter Book's _config.yml file:

(to use all default values)

sphinx:
  extra_extensions:
    - sphinx_juniper
  config:
    juniper: true

To override any/all defaults:

sphinx:
  extra_extensions:
    - sphinx_juniper
  config:
    juniper:
      url: https://mybinder.org  # BinderHub instance
      repo: ashtonmv/python_binder  # Github repository for Binder image
      theme: monokai  # Styling (only monokai and material supported for now)
      isolateCells: false  # Whether to share variables between cells
      useStorage: true  # Cache the kernel connection between page loads
      ...
      etc.
      ...

Similar to BinderHub links and Colab links, sphinx-juniper only acts on Ipython Notebooks included in your documentation! It adds a button to the "launch_buttons" (the one with a rocket on it) dropdown menu for these pages at the top. Clicking this button will start the connection to the kernel you've configured based on the settings in _config.yml above.