From 3053e08bac8591cb453a2e8e7a04aeb274124186 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Wed, 29 Aug 2018 14:28:40 -0500 Subject: [PATCH 1/2] Bump version and update changelog --- docs/source/changelog.rst | 74 +++++++++++++++++++++++++++++++++------ nbconvert/_version.py | 22 ++++++------ 2 files changed, 75 insertions(+), 21 deletions(-) diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 73c9b2714..5833e0cf4 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -4,6 +4,60 @@ Changes in nbconvert ==================== +5.4 +--- +`5.4 on Github `__ + +- 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 `__ @@ -28,15 +82,15 @@ 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 `__. -**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=[]})``. +using a call like ``display(your_output_element, metadata={tags=[]})``. *NB*: Use different tags depending on whether you want to remove the entire cell, the input, all outputs, or individual outputs. @@ -44,11 +98,11 @@ using a call like ``display(your_output_element, metadata={tags=[ Date: Wed, 5 Sep 2018 09:46:37 +0200 Subject: [PATCH 2/2] Add long description, Python requires, project URLS, and https-ify --- setup.py | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index db964ccec..118548960 100644 --- a/setup.py +++ b/setup.py @@ -128,7 +128,7 @@ def run(self): class bdist_egg_disabled(bdist_egg): """Disabled version of bdist_egg - + Prevents setup.py install performing setuptools' default easy_install, which it should never ever do. """ @@ -157,17 +157,38 @@ def run(self): exec(f.read(), {}, version_ns) +long_description=""" + +Nbconvert is a Command Line tool and Python library and API to process and +convert Jupyter notebook into a variety of other formats. + +Using nbconvert enables: + + - presentation of information in familiar formats, such as PDF. + - publishing of research using LaTeX and opens the door for embedding notebooks in papers. + - collaboration with others who may not use the notebook in their work. + - sharing contents with many people via the web using HTML. +""" + setup_args = dict( name = name, description = "Converting Jupyter Notebooks", version = version_ns['__version__'], scripts = glob(pjoin('scripts', '*')), packages = packages, + long_description= long_description, + python_requires = '>=2.6,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*', package_data = package_data, cmdclass = cmdclass, author = 'Jupyter Development Team', author_email = 'jupyter@googlegroups.com', - url = 'http://jupyter.org', + url = 'https://jupyter.org', + project_urls={ + 'Documentation': 'https://nbconvert.readthedocs.io/en/latest/', + 'Funding' : 'https://numfocus.org/', + 'Source' : 'https://github.com/jupyter/nbconvert', + 'Tracker' : 'https://github.com/jupyter/nbconvert/issues', + }, license = 'BSD', platforms = "Linux, Mac OS X, Windows", keywords = ['Interactive', 'Interpreter', 'Shell', 'Web'], @@ -227,7 +248,7 @@ def run(self): 'rst=nbconvert.exporters:RSTExporter', 'notebook=nbconvert.exporters:NotebookExporter', 'asciidoc=nbconvert.exporters:ASCIIDocExporter', - 'script=nbconvert.exporters:ScriptExporter'] + 'script=nbconvert.exporters:ScriptExporter'] } setup_args.pop('scripts', None)