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

Split docs to kernel-mgmt #4

Merged
merged 2 commits into from
Nov 1, 2019
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ __pycache__
.cache
.pytest_cache
absolute.json
.idea
8 changes: 4 additions & 4 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/jupyter_client.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/jupyter_protocol.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/jupyter_client.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/jupyter_protocol.qhc"

applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
Expand All @@ -104,8 +104,8 @@ devhelp:
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/jupyter_client"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/jupyter_client"
@echo "# mkdir -p $$HOME/.local/share/devhelp/jupyter_protocol"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/jupyter_protocol"
@echo "# devhelp"

epub:
Expand Down
43 changes: 0 additions & 43 deletions docs/api/client.rst

This file was deleted.

12 changes: 0 additions & 12 deletions docs/api/index.rst

This file was deleted.

66 changes: 0 additions & 66 deletions docs/api/kernelspec.rst

This file was deleted.

58 changes: 0 additions & 58 deletions docs/api/manager.rst

This file was deleted.

155 changes: 7 additions & 148 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,155 +1,14 @@
.. _changelog:

=========================
Changes in Jupyter Client
=========================
===========================
Changes in Jupyter Protocol
===========================

5.1
===

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

- Define Jupyter protocol version 5.2,
resolving ambiguity of ``cursor_pos`` field in the presence
of unicode surrogate pairs.

.. seealso::

:ref:`cursor_pos_unicode_note`

- Add :meth:`Session.clone` for making a copy of a Session object
without sharing the digest history.
Reusing a single Session object to connect multiple sockets
to the same IOPub peer can cause digest collisions.
- Avoid global references preventing garbage collection of background threads.


5.0
===

5.0.1
-----

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

- Update internal protocol version number to 5.1,
which should have been done in 5.0.0.

5.0.0
-----

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

New features:

- Implement Jupyter protocol version 5.1.
- Introduce :command:`jupyter run` command for running scripts with a kernel, for instance::

jupyter run --kernel python3 myscript.py

- New method :meth:`.BlockingKernelClient.execute_interactive`
for running code and capturing or redisplaying its output.
- New ``KernelManager.shutdown_wait_time`` configurable for adjusting the time
for a kernel manager to wait after politely requesting shutdown
before it resorts to forceful termination.

Fixes:

- Set sticky bit on connection-file directory to avoid getting cleaned up.
- :func:`jupyter_client.launcher.launch_kernel` passes through additional options to the underlying Popen,
matching :meth:`KernelManager.start_kernel`.
- Check types of ``buffers`` argument in :meth:`.Session.send`,
so that TypeErrors are raised immediately,
rather than in the eventloop.

Changes:

- In kernelspecs, if the executable is the string ``python`` (as opposed to an absolute path),
``sys.executable`` will be used rather than resolving ``python`` on PATH.
This should enable Python-based kernels to install kernelspecs as part of wheels.
- kernelspec names are now validated.
They should only include ascii letters and numbers, plus period, hyphen, and underscore.

Backward-incompatible changes:

- :py:class:`.datetime` objects returned in parsed messages are now always timezone-aware.
Timestamps in messages without timezone info are interpreted as the local timezone,
as this was the behavior in earlier versions.


4.4
===

4.4.0
-----

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

- Add :meth:`.KernelClient.load_connection_info` on KernelClient, etc. for loading connection info
directly from a dict, not just from files.
- Include parent headers when adapting messages from older protocol implementations
(treats parent headers the same as headers).
- Compatibility fixes in tests for recent changes in ipykernel.

4.3
===

4.3.0
-----

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

- Adds ``--sys-prefix`` argument to :command:`jupyter kernelspec install`,
for better symmetry with :command:`jupyter nbextension install`, etc.

4.2
===

4.2.2
-----

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

- Another fix for the :func:`start_new_kernel` issue in 4.2.1 affecting slow-starting kernels.


4.2.1
0.1.0
-----

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

- Fix regression in 4.2 causing :func:`start_new_kernel`
to fail while waiting for kernels to become available.


4.2.0
-----

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

- added :command:`jupyter kernelspec remove` for removing kernelspecs
- allow specifying the environment for kernel processes via the ``env`` argument
- added ``name`` field to connection files identifying the kernelspec name,
so that consumers of connection files (alternate frontends) can identify the kernelspec in use
- added :meth:`KernelSpecManager.get_all_specs` for getting all kernelspecs more efficiently
- various improvements to error messages and documentation

4.1
===

4.1.0
-----

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

Highlights:

- Setuptools fixes for ``jupyter kernelspec``
- ``jupyter kernelspec list`` includes paths
- add :meth:`KernelManager.blocking_client`
- provisional implementation of ``comm_info`` requests from upcoming 5.1 release of the protocol
- Initial experimental implementation.

4.0
===

The first release of Jupyter Client as its own package.
Note: Because the code in this repository originated from jupyter_client you may
also want to look at its `changelog history <https://jupyter-client.readthedocs.io/en/latest/changelog.html>`_.
Loading