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.

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

Start writing release notes for 5.2 #315

Merged
merged 3 commits into from
Dec 18, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,48 @@
Changes in Jupyter Client
=========================

5.2
===

`5.2 on GitHub <https://github.com/jupyter/jupyter_client/milestones/5.2>`__

- Define Jupyter protocol version 5.3:

- Kernels can now opt to be interrupted by a message sent on the control channel
instead of a system signal. See :ref:`kernelspecs` and :ref:`msging_interrupt`
(:ghpull:`294`).

- New ``jupyter kernel`` command to launch an installed kernel by name
(:ghpull:`240`).
- Kernelspecs where the command starts with e.g. ``python3`` or
``python3.6``—matching the version ``jupyter_client`` is running on—are now
launched with the same Python executable as the launching process (:ghpull:`306`).
This extends the special handling of ``python`` added in 5.0.
- Command line arguments specified by a kernelspec can now include
``{resource_dir}``, which will be substituted with the kernelspec resource
directory path when the kernel is launched (:ghpull:`289`).
- Kernelspecs now have an optional ``metadata`` field to hold arbitrary metadata
about kernels—see :ref:`kernelspecs` (:ghpull:`274`).
- Make the ``KernelRestarter`` class used by a ``KernelManager`` configurable
(:ghpull:`290`).
- When killing a kernel on Unix, kill its process group (:ghpull:`314`).
- If a kernel dies soon after starting, reassign random ports before restarting
it, in case one of the previously chosen ports has been bound by another
process (:ghpull:`279`).
- Avoid unnecessary filesystem operations when finding a kernelspec with
:meth:`.KernelSpecManager.get_kernel_spec` (:ghpull:`311`).
- :meth:`.KernelSpecManager.get_all_specs` will no longer raise an exception on
encountering an invalid ``kernel.json`` file. It will raise a warning and
continue (:ghpull:`310`).
- Check for non-contiguous buffers before trying to send them through ZMQ
(:ghpull:`258`).
- Compatibility with upcoming Tornado version 5.0 (:ghpull:`304`).
- Simplify setup code by always using setuptools (:ghpull:`284`).
- Soften warnings when setting the sticky bit on runtime files fails
(:ghpull:`286`).
- Various corrections and improvements to documentation.


5.1
===

Expand Down
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinxcontrib_github_alt',
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -55,6 +56,8 @@
copyright = '2015, Jupyter Development Team'
author = 'Jupyter Development Team'

github_project_url = "https://github.com/jupyter/jupyter_client"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
Expand Down
2 changes: 2 additions & 0 deletions docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ dependencies:
- jupyter_core
- sphinx>=1.3.6
- sphinx_rtd_theme
- pip:
- sphinxcontrib_github_alt