Skip to content

Commit

Permalink
Fix lumino documentation links on 4.0 (#207)
Browse files Browse the repository at this point in the history
* Fix lumino documentation links

* Fix workflows

Co-authored-by: Frédéric Collonval <[email protected]>
  • Loading branch information
krassowski and fcollonval committed Mar 27, 2023
1 parent 5d4e804 commit 4ef3dd5
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion contentheader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion datagrid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion kernel-messaging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion signals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion widgets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 4ef3dd5

Please sign in to comment.