CHANGELOG.md

Changelog

All notable changes to this project should be documented in this file.

The format is based on Keep a Changelog and this project adheres (at least as of 0.3.0!) to Semantic Versioning.

Note also that since this markdown is used to produce our docs at jupyter-contrib-nbextensions.readthedocs.io via recommonmark, (and GitHub links aren't automatically added by recommonmark), it'd be helpful if you could explicitly link github PR/issue numbers and any URIs, to make sure our readthedocs stuff gets all the shiny link goodness. Thanks!

Unreleased (aka. GitHub master)

This is where each new PR to the project should add a summary of its changes, which makes it much easier to fill in each release's changelog :)

0.5.1

• Fix for navigation hotkeys #1378
• gist_it Making github endpoint configurable to support publishing gists to Github Enterprise #1364
• Fix treefilter #1359
• Enable ruler extension in editor #1296
• Several spelling fixes

Travis/AppVeyor testing is currently broken due to outdated configuration. Will hopefully be working in 0.5.2 again.

0.5.0

Repo-level stuff:

• Added CONTRIBUTING.md (fixes #1224) #1225 @consideratio
• [ci] allow lint failure on travis #1228 @jcb91
• Fix some travis warnings and errors #1251 @juhasch
• Remove OSX travis run (OSX still supported, but travis run kept failing without being any significant difference to linux run) #1253 @juhasch/fix
• fix travis for py27 #1265 @jcb91

New features and bugfixes:

• load_tex_macros new nbextension added! #1257 @ketch
• cell_filter new nbextension added! #1240 @benelot
• execution_dependencies new nbextension added! #1213 @benelot
• isort new nbextension added! First implementation based on code_prettify #1204 @benjaminabel
• require newer jupyter_highlight_selected_word #1270 @jcb91
• Fix for long button labels in code_prettify and variants #1268 @jfbercher
• Bugfix for collapsible_headings key bindings conflict #1264 @rhilenova
• kernel_exec_on_cells, make shift-click on button autoformat all cells #1219 @jcb91
• scroll_down ensure output will scroll down in new cells #1227 @cjld
• init_cell Warning dialog now always relevant, fixes #1223. #1226 @consideratio
• gist_it, Fixed a minor spelling mistake in the documentation #1222 @swedishmike
• toc2
  • fix css rule for overriding wrapper color #1255 @jcb91
  • allow configurable basenumber #1252 @jfbercher
  • Initialize toc2 button after cfg is loaded / fix #1249. #1250 @jfbercher
  • use unaltered notebook metadata in template #1141 @jcb91
• exercise & exercise2, Reworking to fix #1079 #1206 @jcb91
• snippets use base_url #1212 @juhasch
• Add preprocessor to embed images into a notebook #1067 @juhasch
• init_cell
  • Warning dialog now always relevant, fixes #1223. #1226 @consideratio
• Add preprocessor to embed images into a notebook #1067 @juhasch
• Fixed conflicts in collapsible_headings if keys are rebound. @rhilenova

0.4.0

Repo-level stuff:

• Require newer version of jupyter_nbextensions_configurator #1197 @jcb91
• Remove version-pinning from lxml dependency #1174 @codypiersall
• Use requirejs vs. require, to align with notebook usage #1165 @gnestor
• tests specify exceptions (new flake8 moan) #1143 @jcb91
• move js_highlight.py into nbconvert_support, specify exception type #1140 @jcb91
• docs updates #1200, #1201 @jcb91

New features and bugfixes:

• livemdpreview new nbextension added! #1155 @jcb91
• nbTranslate
  • Typos + readability improvements #1191 @adyavanapalli,
  • Fix typo and revise text for better readability #1190 @adyavanapalli,
  • use traitlets > 4.1 tag API #1138 @jcb91
• collapsible_headings
  • indent heading collapse controls by level #1183 @jcb91
  • patch TextCell.set_text to catch more changes #1184 @jcb91
  • link complete font-awesome css from cdn, not just some fontfaces #1179 @jcb91
• toc2
  • Add a 'download as HTML with toc' for Jupyter >= 5.1 #1182 @jfbercher
  • only set notebook dirty if metadata item changed #1178 @jcb91
  • Bugfix undefined title_sidebar #1175 @jfbercher
  • move config into toc2.js #1167 @jcb91
  • configurable titles; dialog-alterable metadata settings #1124 @jcb91
  • remove deprecated st var from template #1199 @jcb91
  • [toc2] link complete font-awesome css from cdn #1198 @jcb91
• scroll_down fix notebook 5.x compatibility #1181 @jcb91
• exercise,exercise2 use bootstrap hidden class rather than jquery show/hide, in order to play nicely with collapsible_headings. fixes #990 #1169 @jcb91
• runtools don't alter selection when running cells #1145 @jcb91
• ExecuteTime add preprocessor to execute notebook updating timing metadata #1139 @jcb91
• snippets Updated README #1150 @chuaxr
• code_prettify Update code_prettify.yaml #1162 @fehiepsi

0.3.3

• #1128 bugfix for notebook < 5.2.0, bugs introduced by @jcb91 in #1123

0.3.2

Repo-level stuff:

• #1097 @juhasch Increase lint's allowed line length to 120
• #1100 @juhasch Add note about --skip-running-check flag to docs
• #1117 @jcb91 test yaml files using jupyter_nbextensions_configurator to avoid any yaml typos which may prevent nbextensions from getting installed.
• #1103 @Sukneet update add_buttons_group to use action instead of button

New features and bugfixes:

• code_prettify, autopep8 & 2to3 #1118 @jcb91 Merge upstream changes, using textareas for json parameter editing

• collapsible_headings #1109 @jcb91 bugfix: update all headings on markdown rendering

• embedhtml #1052 @gabyx Changed regex parsing in embedhtml.py to XML parsing with lxml, regex

• python-markdown

  • #1081 @yarikoptic fix minor readme typo: currently -> current
  • #1122 @jcb91 avoid js error when marked doesn't wrap things in <p> tags

• ruler #1116 @jcb91 css patch for notebook > 4.2.3 - see jupyter/notebook#2869 for details

• runtools #946 @juhasch Use a scheduling list for running marked cells

• scratchpad #1089 @jcb91 fix typo in yaml

• toc2

  • #1068 @jfbercher Scrolling: add a mark to currently displayed section in TOC window
  • #1084 @jfbercher fix for #1083: Revert full url in links to relative to the current page.
  • #1091 @fkoessel Ensure notebook is not widened if sidebar is displayed and cfg.widenNotebook is unchecked.
  • #1095 @fkjogu Beautify toc2.js using js-beautify
  • #1110 @jcb91 constrain draggable toc to the body
  • #1111 @jcb91 remove unused variables & commented code
  • #1112 @jcb91 use requirejs to get events
  • #1120 @jcb91 simplify ToC cell processing
  • #1121 @jcb91 correct toc tree construction

• zenmode #1062 @soamaven Make hiding of the Header and Menubar optional

Removed/deprecated nbextensions:

• #539 @janschulz Remove deprecated extension search-replace
• #1108 @juhasch Remove deprecated extensions chrome-clipboard, dragdrop, search-replace

0.3.1

Repo-level stuff:

• #1073 @jcb91 Use newer conda version for recipe build test
• #1069 @jcb91 Bugfix in installer, require newer versions of jupyter_contrib_core and jupyter_nbextensions_configurator
• #1059 @jcb91 fix linting errors, disallow linting failure on Travis

New features and bugfixes:

• codefolding
  • #1054 @gabyx [codefolding] preprocessor improvements
  • #1072 @jcb91 fix linting in preprocessor
• dragdrop #1063 @juhasch Add note to docs about native drag&drop support
• toc2 #1066 @jfbercher tentative fix for #1065 by updating jqueryui cdn and version
• for various nbextensions #1061 @jcb91 use Jupyter.notebook.config instance, where appropriate

0.3.0

Alterations to the installation machinery (these are what made the bump to 0.3):

• #992 require nbconvert >=4.2
• #1045 improved running-server checks for installation

Repo-level stuff:

• notebook 5.x: Update various nbextensions to list themselves as compatible #1000, #1002, #1003, #1055
• CI updates: #995 updates for Travis

New features and bugfixes:

• codefolding,
  • #1028 @juhasch Add configurable delay for initialization
  • #1055 @jcb91 fix restoration of nested folds
  • #1058 @juhasch Fix preprocessor configuration
• code_prettify, #1019 @jfbercher added support for IPython magics, cf #1018
• collapsible_headings,
  • #1025 add new (un)collapse-all actions, shortcuts, button
  • #1031 @jcb91 integration with toc2
  • #1060 bugfix for exporter
• ExecuteTime, #1022 @jcb91 add menu items & options for clearing timing data
• export_embedded #1039 @gabyx New nbextension providing a menu item to allow downloading the notebook through the html_embed exporter.
• freeze
  • #1006 @aminought Fix cell removing after copying of freezed cell
  • #1033 @jcb91 fix typo/inconsitent state naming
• html_embed exporter: #1044 @juhasch bugfix for issue #1041: to ensure correct treatment of images already embedded as attachments.
• nbTranslate #998 @jfbercher update to google API modifications
• notify
  • #1036 @baldwint Update notify extension for Jupyter 5.x
  • #1053 @brenns10 Add sound, & sticky options
• scratchpad, #1026 @jcb91 merge upstream fix to stop the scratchpad interfering with the scrollbar in firefox.
• toc2
  • #994 @jfbercher update for cells width and sidebar height
  • #1030 @jfbercher Full url in links | #skip tag to skip headers from being inserted
  • #1031 @jcb91 Make toc entries collapsible, integrate with collapsible_headings
  • #1032 Use amd structure to avoid polluting the global namespace
  • #1035 @jcb91 alter ToC cell source to work better with collapsible_headings
• varInspector
  • #1001 @jcb91 merge upstream fixes, ensuring each library object has its own config object
  • #1016 @jfbercher Fix #1014 and #1015 - reload on %reset magic and fix print on python2

0.2.8

Alterations to the installation machinery:

• #981 fix potential bug in config uninstall

Repo-level stuff: #986, #972, update more nbextensions to list themselves as 5.x-compatible.

New features and bugfixes:

• cellstate #978 @juhasch Stale nbextensions removed
• codefolding #977 @juhasch Fix codefolding gutter load issue
• ExecuteTime #967 @NII Fix highlight.color option
• freeze
  • #966 @NII make cell colors configurable
  • #968 @tnarik use cell.metadata.editable as introduced by notebook 5.x.
  • #976 @yacchin1205 Fix property checking
  • #974 @yacchin1205 Export set/get_state functions
• init_cell #987 @jcb91 fix typo in options-loading code
• ruler #980 @jcb91 fix typo in cm_config defaults
• select_keymap #971 @jcb91 honour default params as declared in yaml
• skip-traceback #957 @jcb91 make traceback collapsed, rather than just omitted entirely. Apply to pre-existing traceback at notebook load, and add a button to copy the traceback
• toc2 #969 @hiiwave Support custom colors for navigation text and window
• tree-filter #948 @wikiped Make search optionally case-insensitve and accept RegExp syntax

Updates to readme/docs: #973 fix link typos and redirects

0.2.7

New nbextensions, new features and bugfixes:

• codefolding
  • #927 @juhasch bugfix, restore default codefolding hotkey
  • #954 @juhasch Make codefolding available in edit view
• collapsible_headings #950 @jcb91 fix tooltip placement bug for notebook 5.x, add 5.x compatibility
• comment-uncomment #953 @juhasch Add option to indent comments to current indent level
• dragdrop #929 @xNok use markdown syntax instead of html
• ExecuteTime #934 @jcb91 honour default_kernel_to_utc for both start and end times
• init_cell #928 @ZelphirKaltstahl bugfix error introduced as part of fixes to #885
• nbTranslate #951 @jfbercher improved code formatting in nbTranslate.py
• runtools #930 @tsankuanglee add tooltips to runtools' many buttons
• varInspector #922 @jfbercher new nbextension a variable inspector!

CI stuff: #955

0.2.6

Fix requirements, which got altered incorrectly as part of the 0.2.5 release.

0.2.5

New nbextensions, new features and bugfixes:

• autoscroll #864 @simplygood fixed a typo in AutoScroll's main.js
• chrome-clipboard #921 @sdsawtelle use utils function to add authentication to upload, fixing #918
• codefolding #908 @juhasch Fixes for languages other than IPython that use non-indent-based blocks.
• codemirror_mode_extensions #905 @jcb91 New nbextension
• collapsible_headings #892 @jcb91 new features including support for embedding into html
• dragdrop #915 @juhasch Bugfix for Firefox
• ExecuteTime #907 @jcb91 new features including configurable utc assumption, relative time display, message templates, right-alignment.
• hide_header #863 @bluss New nbextension to toggle (header + toolbar + menubar) visibility
• #899 @jfbercher highlighter Minor typo update + cleaning
• init_cell #912 @jcb91 allow celltoolbar preset to load from metadata setting
• move_selected_cells #860 @jfbercher updated to Jupyter 4.2+
• nbconvert_support.embed_html #902 @jozjan Updated regex pattern for better match
• scratchpad #919 @jcb91 adopt minrk/scratchpad#12 to bugfix z-index for issue #916
• snippets_menu #917 @moble Fix documentation links
• toc2
  • #846 @jfbercher always read threshold parameter from system config - address #646
  • #872 @jfbercher update template and resize sidebar on resize-header event
  • #887 @jfbercher Add a parameter to enable/disable cell widening
  • #911 @piti118 Use https instead of http for jquery in nbconvert template
• Various fixes to ensure nbextensions load correctly, related to #885: PRs #895, #897, #898, #900, #906
• stale nbextensions removed:
  • history #889
  • read-only #890
  • search, slidemode/slidemode2, swc #891
  • no_exec_dunder, nbviewer_theme #906

Alterations to the installation machinery:

• #874 add traitlets 4.1 to requirements, needed by nbTranslate
• #923 @jcb91 update required versions of jupyter_nbextensions_configurator, jupyter_latex_envs, and jupyter_highlight_selected_word to latest releases

Updates to readme/docs:

• #896 @juhasch Add some more documentation for freeze
• #881 @juhasch Fix graphics in doc
• #875 @jcb91 Docs updates - sort list
• #876 @juhasch Document LaTex templates

CI updates: #862, #894, #920

0.2.4

New nbextensions, new features and bugfixes:

• #839 @jcb91 snippets_menu merge upstream changes
• #844 @jfbercher nbTranslate add help message for keyboard shortcuts
• #843 @jfbercher code_prettify bugfix: reinstate JSON-conversion of results from the R kernel
• #837 @jcb91 code_prettify Merge upstream code-prettify updates
• #838 @jfbercher nbTranslate New nbextension
• #827 @moble snippets_menu New nbextension
• #836 @juhasch Remove strip_output_prompt from nbconvert_support
• #831 @juhasch dragdrop use utils function to add authentication to upload, fixing #830
• #834 @lspvic init_cell fix bug with trust warning
• #826 @adrn code_snippets New nbextension
• #820 @jcb91 hinterland disable hints in comments (configurable), fixing #819
• #815 @jcb91 hinterland make all regexes configurable, addressing #651

Updates to readme/docs:

• #845 @aiguofer Add note about helpful firefox extension to select_keymap docs
• #850 @juhasch Describe nbextensions custom template
• #833 @jcb91 updates to readme and docs, addressing #740
• #825 @jcb91 readme updates to specllchecker, codefolding, gist_it, readonly
• #816 @jcb91 update docs build to include nbextensions provided by dependencies

Some CI updates: #824

0.2.3

Alterations to the installation machinery:

• #801 @jcb91 updates to migrate script addressing renames
• #807 @jcb91 setup.py fixes

New nbextensions, new features and bugfixes:

• #796 @oxinabox AddBefore Add new nbextension
• #746, #802 @jfbercher, @jcb91 latex_envs replace vendored latex_envs with its pypi package
• #794 @juhasch codefolding Only execute codefolding preprocessor when requested
• #804 @jcb91 jupyter_highlight_selected_word add jupyter_highlight_selected_word nbextension
• #795 @jfbercher toc2 Highlight toc headings for sections with selected/edited/running cells; fix save issue #762
• #803 @jfbercher toc2 make higlight colours configurable; configurably allow shifting title, menus & icons to the left, ratehr than centring
• #810 @jfbercher toc2 take account of nb metadata in html export
• #813 @jcb91 limit_output allow per-cell override of limit length, make output-limited notes persist through notebook save & reload, limit outputs even over several distinct output events
• #814 @jcb91 init_cell make automatic running of initialization cells configurable (fixes #812), prevent automatic run of initialization cells in untrusted notebooks

Some CI updates: #797 #806

0.2.2

Alterations to the installation machinery:

• #774 @jcb91 Add flags to install only files/only config modifications.
• #769 @jcb91 Use jupyter_nbextensions_configurator's actual install app

Stale nbextensions removed:

• history, readonly, swc, slidemode #890, #889 @juhasch, #891 @jcb91, none of which have yet even been updated to notebook 4.x

New nbextensions, new features and bugfixes:

• #882 @juhasch limit_output enable independent limiting of different kernel message types
• #877 @jfbercher toc2 Remove MathJax preview in headers and links
• Fixes for timings issues related to the notebook_loaded.Notebook event, as raised in issue #885. Fixes for hide_input, hide_input_all, ruler, splitcell in #886 @jcb91, for codefolding in #888 @juhasch for freeze in #884 @kukanya for execute_time in #883 @jcb91
• #787 @jcb91 scratchpad Updates from master repo
• #784 @azjps limit_output fix missing braces
• #768 @lll9p collapsible_headings Make level test code robust to undefined cell
• #770 @jfbercher code_prettify Update to address #767
• #765 @kukanya Freeze Extend functionality to markdown cells
• #781 @kukanya ScrollDown Add new nbextension

Updates to readme/docs:

• #790 @juhasch mention PyPi install source in readme
• #789 @jcb91 A few minor readme updates
• #788 @jcb91 update installation instructions
• #773 @jcb91 generate docs without conversion

Some CI updates: #778, #779, #772, #771, #766

0.2.1

New nbextensions, new features and bugfixes:

• New html_embed nbconvert exporter
• Added select_keymap nbextension
• added tests for toc2 and html_embed exporters
• tooltips on highlighter
• toc2 issue with zero-length navigation menu
• switch table_beautifier from bootstrap-table to tablesorter plugin
• code_prettify: corrected insufficient re replacement
• dragdrop fix url generation when using non-default base_url

Updates to readme/docs:

• get docs readable at jupyter-contrib-nbextensions.readthedocs.io
• add an auto-enabled nbextension contrib_nbextensions_help_item, which adds a help menu item to point at RTD
• Add missing readmes & yaml links to readmes

0.2.0

Alterations to the installation machinery:

• alter app default settings, making --user flag in install app default to False
• add plural nbextensions command alias i.e. jupyter contrib nbextensions as an alias of jupyter contrib nbextension
• conda-forge recipe & installation instructions added

New nbextensions, new features and bugfixes:

• new code_prettify extension
• latex_envs: update for MathJax use and html export; add latex_envs.py - exporter library; add templates for conversion; configure entry points for exporters in setup.py; update readme.
• toc2 modifications to templates, configure entry points for exporters in setup.py, update README
• breakpoints removed stale extension
• Bugfixes: limit_output, postprocessors, nbconvert support

Updates to readme/docs:

• Add docs generation
• Add lots of missing readme & yaml files
• Attempt to get docs builds working on readthedocs

Plus various CI & packaging fixes/improvements

0.1.0

First release with pep-440 compatible versioning!