Converting Notebooks to HTML¶
Options
jupyter_generate_html¶
Enable sphinx to generate HTML versions of notebooks
| Values |
|---|
| False (default) |
| True |
conf.py usage:
jupyter_generate_html = True
jupyter_html_template¶
Specify path to nbconvert html template file
Note
Documentation on nbconvert templates can be found here
conf.py usage:
jupyter_html_template = "theme/template/<file>.tpl"
jupyter_make_site¶
Enable sphinx to construct a complete website
Todo
Document all the extra elements this option does over jupyter_generate_html
This option:
- fetches coverage statistics if coverage is enabled.
conf.py usage:
jupyter_make_site = True
jupyter_download_nb¶
Request Sphinx to generate a collection of download notebooks to support a website
conf.py usage:
jupyter_download_nb = True
jupyter_images_urlpath¶
Apply a url prefix when writing images in Jupyter notebooks. This is useful when
paired with jupyter_download_nb so that download notebooks are complete with
web referenced images.
conf.py usage:
jupyter_images_urlpath = "s3://<path>/_static/img/"