FEAT: add urlprefix capability for images in notebooks

QuantEcon / sphinxcontrib-jupyter

A Sphinx Extension for Generating Jupyter Notebooks

BSD 3-Clause "New" or "Revised" License

76 stars 23 forks source link

FEAT: add urlprefix capability for images in notebooks #138

Closed mmcky closed 5 years ago

mmcky commented 5 years ago

This PR adds the ability to specify a web location for embedded images in notebooks. This reduces the need to track _static assets as long as they are published in a web location. This PR addresses #116.

Usage

The option jupyter_images_urlpath = "https://<address>/" can be specified in the conf.py file which will swap the relative reference to _static for a web location.

The default action is to use local file references in a _static folder with jupyter_images_urlpath = None

mmcky commented 5 years ago

[x] this needs to be improved as it assumes the file is located at the root level of _static.