From 18177154f41e459086a20f4bcc2a1a536620a243 Mon Sep 17 00:00:00 2001 From: Matthew Seal Date: Fri, 2 Oct 2020 15:35:49 -0700 Subject: [PATCH] Preped documentation for release --- docs/source/changelog.rst | 36 ++++++++++++++++++++++++++++++++++++ docs/source/customizing.rst | 12 ++++++++++++ 2 files changed, 48 insertions(+) diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 78e4d374b..8ae7c303a 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -4,6 +4,42 @@ Changes in nbconvert ==================== +6.0.7 +----- + +Primarly a release addressing template extensions issues reported since 6.0 launched. + +Comprehensive notes +~~~~~~~~~~~~~~~~~~~ + +- Comment typo fix :ghpull:`1425`: +- Documented updated to default conversion changes from 6.0 :ghpull:`1426`: +- Allow custom template files outside of the template system to set their base template name :ghpull:`1429`: +- Restored basic template from 5.x :ghpull:`1431`: +- Added proper support for backwards compatibility templates :ghpull:`1431`: + +6.0.6 +----- + +A range of bug fixes for webpdf exports + +Comprehensive notes +~~~~~~~~~~~~~~~~~~~ + +- Removed CSS preprocessor from default proprocessor list (fixes classic rendering) :ghpull:`1411`: +- Fixed error when pickling TemplateExporter :ghpull:`1399`: +- Support for fractional height html / webpdf exports :ghpull:`1413`: +- Added short wait time for fonts and rendering in webpdf :ghpull:`1414`: +- Updated template documentation +- Minor fixes to the webpdf exporter :ghpull:`1419`: +- Fixup use with a running event loop within webpdf :ghpull:`1420`: +- Prevent overflow in input areas in lab template :ghpull:`1422`: + +6.0.5 +----- + +- Revert networkidle2 change which caused custom cdn-fetched widgets in webpdf + 6.0.4 ----- diff --git a/docs/source/customizing.rst b/docs/source/customizing.rst index 17f2cf490..f7e02c202 100644 --- a/docs/source/customizing.rst +++ b/docs/source/customizing.rst @@ -52,6 +52,18 @@ For example, three HTML templates are provided in nbconvert core for the HTML ex /home//.local/share/jupyter/runtime +Adding Additional Template Paths +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In order to add additional paths to be searched, you need to pass ``TemplateExporter.extra_template_basedirs`` +config options indicating the extra directories to search for templates. Be careful not to override +``TemplateExporter.template_paths`` unless you intend to replace ALL paths and don't want the default +locations included. + +When using the commandline the extra template paths are added by calling +``--TemplateExporter.extra_template_basedirs=path/you/want/included``. + + The content of nbconvert templates ----------------------------------