ipython · Jan 3, 2023 · Jan 3, 2023 · Jan 8, 2023 · Jan 9, 2023 · Jan 9, 2023
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -93,6 +93,15 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - name: Build API docs
+        run: |
+          hatch run docs:api
+          # If this fails run `hatch run docs:api` locally
+          # and commit.
+          git status --porcelain
+          git status -s | grep "A" && exit 1
+          git status -s | grep "M" && exit 1
+          echo "API docs done"
       - run: hatch run docs:build
 
   test_without_debugpy:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -31,12 +31,12 @@ repos:
       - id: mdformat
 
   - repo: https://github.com/psf/black
-    rev: 22.10.0
+    rev: 22.12.0
     hooks:
       - id: black
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.189
+    rev: v0.0.215
     hooks:
       - id: ruff
         args: ["--fix"]
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,31 @@
 
 <!-- <START NEW CHANGELOG ENTRY> -->
 
+## 6.20.1
+
+([Full Changelog](https://github.com/ipython/ipykernel/compare/v6.20.0...5f07abc22a1c75672f7bee129505f19c954a7c36))
+
+### Bugs fixed
+
+- Don't raise error when trying to create another Qt app for Qt eventloop [#1071](https://github.com/ipython/ipykernel/pull/1071) ([@ccordoba12](https://github.com/ccordoba12))
+
+### Maintenance and upkeep improvements
+
+- Update CI [#1073](https://github.com/ipython/ipykernel/pull/1073) ([@blink1073](https://github.com/blink1073))
+- Fix types and sync lint deps [#1070](https://github.com/ipython/ipykernel/pull/1070) ([@blink1073](https://github.com/blink1073))
+
+### Documentation improvements
+
+- Add api docs [#1067](https://github.com/ipython/ipykernel/pull/1067) ([@blink1073](https://github.com/blink1073))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/ipython/ipykernel/graphs/contributors?from=2022-12-26&to=2023-01-09&type=c))
+
+[@blink1073](https://github.com/search?q=repo%3Aipython%2Fipykernel+involves%3Ablink1073+updated%3A2022-12-26..2023-01-09&type=Issues) | [@ccordoba12](https://github.com/search?q=repo%3Aipython%2Fipykernel+involves%3Accordoba12+updated%3A2022-12-26..2023-01-09&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Aipython%2Fipykernel+involves%3Apre-commit-ci+updated%3A2022-12-26..2023-01-09&type=Issues)
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
 ## 6.20.0
 
 ([Full Changelog](https://github.com/ipython/ipykernel/compare/v6.19.4...fbea757e117c1d3b0da29a40b4abcf3133a310f4))
@@ -20,8 +45,6 @@
 
 [@blink1073](https://github.com/search?q=repo%3Aipython%2Fipykernel+involves%3Ablink1073+updated%3A2022-12-20..2022-12-26&type=Issues) | [@shaperilio](https://github.com/search?q=repo%3Aipython%2Fipykernel+involves%3Ashaperilio+updated%3A2022-12-20..2022-12-26&type=Issues)
 
-<!-- <END NEW CHANGELOG ENTRY> -->
-
 ## 6.19.4
 
 ([Full Changelog](https://github.com/ipython/ipykernel/compare/v6.19.3...07da48e686b5906525c2a6b8cfc11cd7c3d96a5f))

diff --git a/docs/api/ipykernel.comm.rst b/docs/api/ipykernel.comm.rst
@@ -0,0 +1,25 @@
+ipykernel.comm package
+======================
+
+Submodules
+----------
+
+
+.. automodule:: ipykernel.comm.comm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.comm.manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ipykernel.comm
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ipykernel.inprocess.rst b/docs/api/ipykernel.inprocess.rst
@@ -0,0 +1,55 @@
+ipykernel.inprocess package
+===========================
+
+Submodules
+----------
+
+
+.. automodule:: ipykernel.inprocess.blocking
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.inprocess.channels
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.inprocess.client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.inprocess.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.inprocess.ipkernel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.inprocess.manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.inprocess.socket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ipykernel.inprocess
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/ipykernel.rst b/docs/api/ipykernel.rst
@@ -0,0 +1,130 @@
+ipykernel package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ipykernel.comm
+   ipykernel.inprocess
+
+Submodules
+----------
+
+
+.. automodule:: ipykernel.compiler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.connect
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.control
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.debugger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.displayhook
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.embed
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.eventloops
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.heartbeat
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.iostream
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.ipkernel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.jsonutil
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.kernelapp
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.kernelbase
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.kernelspec
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.log
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.parentpoller
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.trio_runner
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+.. automodule:: ipykernel.zmqshell
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ipykernel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/modules.rst b/docs/api/modules.rst
@@ -0,0 +1,7 @@
+ipykernel
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   ipykernel
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinxcontrib_github_alt",
+    "sphinx_autodoc_typehints",
 ]
 
 try:

diff --git a/docs/index.rst b/docs/index.rst
@@ -9,9 +9,10 @@ Most IPython kernel documentation is in the `IPython documentation <https://ipyt
 Contents:
 
 .. toctree::
-    :maxdepth: 2
+    :maxdepth: 1
 
     changelog
+    API docs <api/modules>
 
 
 Indices and tables

diff --git a/ipykernel/_version.py b/ipykernel/_version.py
@@ -5,7 +5,7 @@
 from typing import List
 
 # Version string must appear intact for hatch versioning
-__version__ = "6.20.0"
+__version__ = "6.20.1"
 
 # Build up version_info tuple for backwards compatibility
 pattern = r"(?P<major>\d+).(?P<minor>\d+).(?P<patch>\d+)(?P<rest>.*)"

diff --git a/ipykernel/comm/comm.py b/ipykernel/comm/comm.py
@@ -18,7 +18,7 @@
 class BaseComm(comm.base_comm.BaseComm):
     """The base class for comms."""
 
-    kernel: Optional[Kernel] = None
+    kernel: Optional["Kernel"] = None
 
     def publish_msg(self, msg_type, data=None, metadata=None, buffers=None, **keys):
         """Helper for sending a comm message on IOPub"""

diff --git a/ipykernel/connect.py b/ipykernel/connect.py
@@ -26,7 +26,8 @@ def get_connection_file(app=None):
         from ipykernel.kernelapp import IPKernelApp
 
         if not IPKernelApp.initialized():
-            raise RuntimeError("app not specified, and not in a running Kernel")
+            msg = "app not specified, and not in a running Kernel"
+            raise RuntimeError(msg)
 
         app = IPKernelApp.instance()
     return filefind(app.connection_file, [".", app.connection_dir])

diff --git a/ipykernel/embed.py b/ipykernel/embed.py
@@ -24,7 +24,7 @@ def embed_kernel(module=None, local_ns=None, **kwargs):
         The module to load into IPython globals (default: caller)
     local_ns : dict, optional
         The namespace to load into IPython user namespace (default: caller)
-    **kwargs : various, optional
+    kwargs : dict, optional
         Further keyword args are relayed to the IPKernelApp constructor,
         allowing configuration of the Kernel.  Will only have an effect
         on the first embed_kernel call for a given process.