Added all_concurrency_run_modes to Kernel.

Rename 'direct' to 'blocking' and improve some documentation.
Print some message when suppressing the error; added a metatakey 'suppress_error_message'.
Added a sleep(0) to _stop_on_error_time to clear any waiting messages.

Author: fleming79

.vscode/settings.json

@@ -16,5 +16,7 @@
     "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
     "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
     "tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
-  ]
+  ],
+  "spellright.language": ["en"],
+  "spellright.documentTypes": ["markdown", "latex", "plaintext", "python"]
 }

CONTRIBUTING.md

@@ -30,16 +30,16 @@ pytest -vv --cov
 
 ## Code Styling
 
-`Async kernel` uses ruff for code formatting.
-the pre-commit hook should take care of how it should look.
-To install `pre-commit`, run the following::
+`Async kernel` uses ruff for code formatting. The pre-commit hook should take care of how it should look.
+
+To install `pre-commit`, run the following:
 
 ```shell
 pip install pre-commit
 pre-commit install
 ```
 
-You can invoke the pre-commit hook by hand at any time with::
+You can invoke the pre-commit hook by hand at any time with:
 
 ```shell
 pre-commit run

README.md

@@ -10,13 +10,10 @@ Async kernel is a Python [Jupyter kernel](https://docs.jupyter.org/en/latest/pro
 
 ## Highlights
 
-- Asynchronous
-- Comms is not blocked during cell execution[^non-blocking-execution]
-- Concurrent code execution [^run-concurrent]
+- Concurrent message handling
 - [Debugger client](https://jupyterlab.readthedocs.io/en/latest/user/debugger.html#debugger)
 - Configurable backend - "asyncio" (default) or "trio backend" [^config-backend]
 - [IPython](https://pypi.org/project/ipython/) shell for magic, code completions, and history
-- No tornado - instead using anyio's [`wait_readable`](https://anyio.readthedocs.io/en/stable/api.html#anyio.wait_readable) to wait for incoming messages on zmq sockets
 
 ## Installation
 
@@ -38,13 +35,4 @@ async-kernel -a async-trio
 
 [![Link to demo](https://github.com/user-attachments/assets/9a4935ba-6af8-4c9f-bc67-b256be368811)](https://fleming79.github.io/async-kernel/simple_example/ "Show demo notebook.")
 
-[^non-blocking-execution]: Shell messaging runs in a task separate to execute requests in the main thread. This means shell messages (including comms) can pass freely whilst an execute request is busy awaiting a result.
-
-[^run-concurrent]: Code can also be scheduled for concurrent execution by adding `##task` or `##thread` at the top of the cell.
-
-    Works with concurrent cell execution
-
-    - [x] Jupyterlab
-    - [ ] VS code - runs one cell at a time
-
 [^config-backend]: The default backend is 'asyncio'. To add a 'trio' backend, define a KernelSpec with a kernel name that includes trio in it.

docs/about/index.md

@@ -0,0 +1,6 @@
+---
+title: About
+description: Notes about contributing, changelog and development.
+icon:
+# subtitle: A sub title
+---

docs/index.md

@@ -1 +1,7 @@
+---
+title: Reference
+description: Readme.
+icon: material/home
+---
+
 --8<-- "README.md"

docs/notebooks/index.md

@@ -0,0 +1,18 @@
+---
+title: Notebooks
+description: Example notebooks for async kernel.
+icon: material/note-text
+# subtitle: A sub title
+---
+
+# Notebooks
+
+Notebooks in this documentation show the result of each cell after executing for a short duration (~100ms).
+
+You can download the notebook with the button at the top right of the page for the notebook.
+
+!!! note
+
+    The [suppress-error][async_kernel.typing.Tags.suppress_error] tag is inserted in code cells to enable
+    with generating documentation. The symbol '⚠' is an indicator that the error was suppressed. Normally
+    this is due to the timeout but there is no distinction on the type of error.