From 4ef3dd5b5e8b1d3b7ab346e4f4e6a440b6450ec3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Krassowski?= <5832902+krassowski@users.noreply.github.com> Date: Fri, 2 Sep 2022 15:00:33 +0100 Subject: [PATCH] Fix lumino documentation links on 4.0 (#207) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fix lumino documentation links * Fix workflows Co-authored-by: Frédéric Collonval --- commands/README.md | 4 ++-- contentheader/README.md | 2 +- datagrid/README.md | 2 +- kernel-messaging/README.md | 2 +- signals/README.md | 2 +- widgets/README.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/commands/README.md b/commands/README.md index 9ee04fed..acc89d28 100644 --- a/commands/README.md +++ b/commands/README.md @@ -15,7 +15,7 @@ It is quite common for an extension to define one or more such commands. In this extension, you are going to add a command to the application command registry. -The registry has `CommandRegistry` type ([documentation](https://lumino.readthedocs.io/en/1.x/api/commands/classes/commandregistry.html)). +The registry has `CommandRegistry` type ([documentation](https://lumino.readthedocs.io/en/stable/api/classes/commands.CommandRegistry-1.html)). To see how you can access the application command registry, open the file `src/index.ts`. @@ -58,7 +58,7 @@ The CommandRegistry is an attribute of the main JupyterLab application adds your own function. That method takes two arguments: the unique command id -and [options](https://lumino.readthedocs.io/en/1.x/api/commands/interfaces/commandregistry.icommandoptions.html) for the command. +and [options](https://lumino.readthedocs.io/en/stable/api/interfaces/commands.CommandRegistry.ICommandOptions.html) for the command. The only mandatory option is `execute`, this takes the function to be called when the command is executed. It can optionally takes arguments (arbitrarily defined diff --git a/contentheader/README.md b/contentheader/README.md index caadb7e3..7cfb64d9 100644 --- a/contentheader/README.md +++ b/contentheader/README.md @@ -87,7 +87,7 @@ For full details see the body of the `execute` function in [`index.ts`](./src/in First, get a `MainAreaWidget`. The approach used here will likely be useful for many JupyterLab use cases: `JupyterFrontEnd.shell.currentWidget` will be a `MainAreaWidget` if your extension is being activated with a classic JupyterLab window, and you can ensure that by testing for `app.shell.currentWidget instanceof MainAreaWidget`. -`MainAreaWidget.contentHeader` is a "top-to-bottom" vertical [Lumino BoxPanel](https://lumino.readthedocs.io/en/1.x/api/widgets/classes/boxpanel.html). You can call its `addWidget` and `insertWidget` methods to populate this space with your own custom widgets. +`MainAreaWidget.contentHeader` is a "top-to-bottom" vertical [Lumino BoxPanel](https://lumino.readthedocs.io/en/stable/api/classes/widgets.BoxPanel-1.html). You can call its `addWidget` and `insertWidget` methods to populate this space with your own custom widgets. ## Background diff --git a/datagrid/README.md b/datagrid/README.md index 89fcda03..61699ff7 100644 --- a/datagrid/README.md +++ b/datagrid/README.md @@ -7,7 +7,7 @@ JupyterLab is built on top of [Lumino](https://github.com/jupyterlab/lumino). That library defines `Widget` as the primary interface brick. -In this example [the datagrid lumino example](https://lumino.readthedocs.io/en/1.x/api/datagrid/classes/datagrid.html) +In this example [the datagrid lumino example](https://lumino.readthedocs.io/en/stable/api/classes/datagrid.DataGrid-1.html) is integrated into JupyterLab. First you need to import `StackedPanel`, `DataGrid` diff --git a/kernel-messaging/README.md b/kernel-messaging/README.md index 6743c884..e3788851 100644 --- a/kernel-messaging/README.md +++ b/kernel-messaging/README.md @@ -76,7 +76,7 @@ const manager = app.serviceManager; With these lines, you can extend the panel widget from the [signal example](../signals) to initialize a kernel. In addition, you will create a `KernelModel` class in it and overwrite the `dispose` and `onCloseRequest` methods of the `StackedPanel` -([see the documentation](https://lumino.readthedocs.io/en/1.x/api/widgets/classes/stackedpanel.html)) +([see the documentation](https://lumino.readthedocs.io/en/stable/api/classes/widgets.StackedPanel-1.html)) to free the kernel session resources if the panel is closed. The whole adapted panel class looks like this: diff --git a/signals/README.md b/signals/README.md index 79a09f07..3463d6eb 100644 --- a/signals/README.md +++ b/signals/README.md @@ -16,7 +16,7 @@ In this extension, a simple HTML button will be added to print something to the JupyterLab's Lumino engine uses the `ISignal` interface and the `Signal` class that implements this interface for communication -(read more on the [documentation](https://lumino.readthedocs.io/en/1.x/api/signaling/index.html) page). +(read more on the [documentation](https://lumino.readthedocs.io/en/stable/api/modules/signaling.html) page). The basic concept is as follows: diff --git a/widgets/README.md b/widgets/README.md index dbd16f35..be754189 100644 --- a/widgets/README.md +++ b/widgets/README.md @@ -4,7 +4,7 @@ In this example you will learn how to add a new tab to JupyterLab. -Visible elements such as tabs and notebooks are represented by widgets in the [Lumino](https://lumino.readthedocs.io/en/1.x/api/widgets/index.html) +Visible elements such as tabs and notebooks are represented by widgets in the [Lumino](https://lumino.readthedocs.io/en/stable/api/modules/widgets.html) library that is the basis of the JupyterLab application. It is the fundamental brick of any visual component in the JupyterLab interface.