Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Release 5.4 #869

Merged
merged 2 commits into from
Sep 5, 2018
Merged

Release 5.4 #869

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3053e08
Bump version and update changelog
blink1073 Aug 29, 2018
e058728
Add long description, Python requires, project URLS, and https-ify
Carreau Sep 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 64 additions & 10 deletions docs/source/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,60 @@
Changes in nbconvert
====================

5.4
---
`5.4 on Github <https://github.com/jupyter/nbconvert/milestones/5.4>`__

- Document ``--inplace`` command line flag. :ghpull:`839`
- Don't remove empty cells by default :ghpull:`784`
- Handle embedded images in html converter :ghpull:`780`
- If set, use ``nb.metadata.authors`` for LaTeX author line :ghpull:`867`
- Add ``export_from_notebook`` :ghpull:`864`
- Fix minor typo in ``usage.rst`` :ghpull:`863`
- Populate language_info metadata when executing :ghpull:`860`
- No need to check for the channels already running :ghpull:`862`
- Update ``font-awesome`` version for slides :ghpull:`793`
- Support for ``\mathscr`` :ghpull:`830`
- Add note about local ``reveal_url_prefix`` :ghpull:`844`
- Properly treat JSON data :ghpull:`847`
- Move ``onlyif_cmds_exist`` decorator to test-specific utils :ghpull:`854`
- Allow the execute preprocessor to make use of an existing kernel :ghpull:`852`
- Update widgets CDN for ipywidgets 7 w/fallback :ghpull:`792`
- Pass config to kernel from ExecutePreprocessor for configurable kernels :ghpull:`816`
- Drop support for python 3.3 :ghpull:`843`
- Include LICENSE file in wheels :ghpull:`827`
- Check for too recent of pandoc version :ghpull:`814`
- Ppdate log.warn (deprecated) to log.warning :ghpull:`804`
- Cleanup notebook.tex during PDF generation :ghpull:`768`
- Add support for adding custom exporters to the "Download as" menu. :ghpull:`759`
- Removing more nose remnants via dependencies. :ghpull:`758`
- Windows unicode error fixed, nosetest added to setup.py :ghpull:`757`
- Added Ubuntu Linux Instructions :ghpull:`724`
- Enable ANSI underline and inverse :ghpull:`696`
- Remove offline statement and add some clarifications in slides docs :ghpull:`743`
- Update notebook css to 5.4.0 :ghpull:`748`
- Change default for slides to direct to the reveal cdn rather than locally :ghpull:`732`
- Better content hiding; template & testing improvements :ghpull:`734`
- Skip executing empty code cells :ghpull:`739`
- Fix Jinja syntax in custom template example. :ghpull:`738`
- Fix for an issue with empty math block :ghpull:`729`
- Use "title" instead of "name" for metadata to match the notebook format :ghpull:`703`
- Linkify PR number :ghpull:`710`
- Img filename metadata :ghpull:`685`
- Added shebang for python :ghpull:`694`
- Upgrade mistune dependency :ghpull:`705`
- Added MathJax compatibility definitions :ghpull:`687`
- Fixes for traitlets 4.1 deprecation warnings :ghpull:`695`
- Per cell exception :ghpull:`684`
- add feature to improve docs by having links to prs :ghpull:`662`
- Raw template as settable attribute :ghpull:`675`
- Update notebook CSS from version 4.3.0 to 5.1.0 :ghpull:`682`
- Update notebook CSS from 4.3.0 to 5.1.0 :ghpull:`1`
- Set BIBINPUTS and BSTINPUTS environment variables when making PDF :ghpull:`676`
- If ``nb.metadata.title`` is set, default to that for notebook :ghpull:`672`
- Explicitly exclude or include all files in Manifest. :ghpull:`670`


5.3.1
-----
`5.3.1 on Github <https://github.com/jupyter/nbconvert/milestones/5.3.1>`__
Expand All @@ -28,27 +82,27 @@ Tags are user-defined strings attached to cells or outputs. They are stored in
cell or output metadata. For more on tags see the `nbformat docs on cell
metadata <http://nbformat.readthedocs.io/en/latest/format_description.html#cell-metadata>`__.

**Usage**:
**Usage**:

1. Apply tags to the elements that you want to remove.

1. Apply tags to the elements that you want to remove.

For removing an entire cell, the cell input, or all cell outputs apply the tag
to the cell.
to the cell.

For removing individual outputs, put the tag in the output metadata
using a call like ``display(your_output_element, metadata={tags=[<your_tags_here>]})``.
using a call like ``display(your_output_element, metadata={tags=[<your_tags_here>]})``.

*NB*: Use different tags depending on whether you want to remove the entire cell, the input, all outputs, or individual outputs.

2. Add the tags for removing the different kinds of elements to the following
traitlets. Which kind of element you want to remove determines which
traitlet you add the tags to.

The following traitlets remove elements of different kinds:
The following traitlets remove elements of different kinds:

- ``remove_cell_tags``: removes cells
- ``remove_cell_tags``: removes cells
- ``remove_input_tags``: removes inputs
- ``remove_all_outputs_tag``: removes all outputs
- ``remove_all_outputs_tag``: removes all outputs
- ``remove_single_output_tag``: removes individual outputs

Comprehensive notes
Expand Down Expand Up @@ -234,8 +288,8 @@ alphabetical order):
- General documentation improvements. For example, testing, installation, custom exporters.
- Improved link handling for LaTeX output
- Refactored the automatic id generation.
- New kernel_manager_class configuration option for allowing systems to be set up to resolve kernels in different ways.
- Kernel errors now will be logged for debugging purposes when executing notebooks.
- New kernel_manager_class configuration option for allowing systems to be set up to resolve kernels in different ways.
- Kernel errors now will be logged for debugging purposes when executing notebooks.

4.3
---
Expand Down
22 changes: 11 additions & 11 deletions nbconvert/_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
version_info = (5, 3, 2)
version_info = (5, 4, 0)
pre_info = ''
dev_info = 'dev'
dev_info = ''

def create_valid_version(release_info, epoch=None, pre_input='', dev_input=''):
'''
Creates a pep440 valid version of version number given a tuple integers
and optional epoch, prerelease and developmental info.
Creates a pep440 valid version of version number given a tuple integers
and optional epoch, prerelease and developmental info.

Parameters
----------
Expand All @@ -16,8 +16,8 @@ def create_valid_version(release_info, epoch=None, pre_input='', dev_input=''):
'''

pep440_err = "The version number is not a pep 440 compliant version number"


if epoch is not None:
epoch_seg = str(epoch) + '!'
else:
Expand All @@ -30,7 +30,7 @@ def create_valid_version(release_info, epoch=None, pre_input='', dev_input=''):
raise ValueError(pep440_err + "\n please fix your prerelease segment.")
else:
pre_seg = pre_input

if dev_input=='':
dev_seg = dev_input
elif not dev_input.startswith('.') and dev_input.startswith('dev'):
Expand All @@ -39,7 +39,7 @@ def create_valid_version(release_info, epoch=None, pre_input='', dev_input=''):
dev_seg = dev_input
elif dev_input!='':
raise ValueError(pep440_err + "\n please fix your development segment.")

if dev_input!='' and not any([dev_seg.endswith(str(n)) for n in range(10)]):
dev_seg = ''.join([dev_seg,'0'])

Expand All @@ -50,14 +50,14 @@ def create_valid_version(release_info, epoch=None, pre_input='', dev_input=''):
def is_canonical(version):
return re.match(r'^([1-9]\d*!)?(0|[1-9]\d*)'
r'(\.(0|[1-9]\d*))*((a|b|rc)(0|[1-9]\d*))?'
r'(\.post(0|[1-9]\d*))?(\.dev(0|[1-9]\d*))?$',
r'(\.post(0|[1-9]\d*))?(\.dev(0|[1-9]\d*))?$',
version
) is not None

if is_canonical(out_version):
return out_version
else:
raise ValueError(pep440_err)


__version__ = create_valid_version(version_info, pre_input=pre_info, dev_input=dev_info)
__version__ = create_valid_version(version_info, pre_input=pre_info, dev_input=dev_info)