Skip to content

Commit

Permalink
Reconfigure 4.1.x branch (4.2.x is new stable) (#16325)
Browse files Browse the repository at this point in the history
  • Loading branch information
krassowski committed May 14, 2024
1 parent 7d1b885 commit ba2431e
Show file tree
Hide file tree
Showing 13 changed files with 35 additions and 35 deletions.
30 changes: 15 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## v4.1

JupyterLab 4.1 includes a number of new features (described below), bug fixes, and enhancements for extension developers. This release is compatible with extensions supporting JupyterLab 4.0. Extension authors are recommended to consult the [Extension Migration Guide](https://jupyterlab.readthedocs.io/en/stable/extension/extension_migration.html#jupyterlab-4-0-to-4-1) which lists deprecations and changes to the public API.
JupyterLab 4.1 includes a number of new features (described below), bug fixes, and enhancements for extension developers. This release is compatible with extensions supporting JupyterLab 4.0. Extension authors are recommended to consult the [Extension Migration Guide](https://jupyterlab.readthedocs.io/en/4.1.x/extension/extension_migration.html#jupyterlab-4-0-to-4-1) which lists deprecations and changes to the public API.

### Custom CSS

Expand All @@ -15,7 +15,7 @@ Themes are the recommended way for customizing the JupyterLab look and feel,
while custom CSS is intended for minor personal adjustments.

To opt in, start JupyterLab with the `--custom-css` flag.
The location of the `custom.css` file is documented in the section on [customizing the user interface](https://jupyterlab.readthedocs.io/en/stable/user/interface_customization.html#custom-css).
The location of the `custom.css` file is documented in the section on [customizing the user interface](https://jupyterlab.readthedocs.io/en/4.1.x/user/interface_customization.html#custom-css).

```{note}
`custom.css` is also available in Jupyter Notebook;
Expand Down Expand Up @@ -113,11 +113,11 @@ Individual plugins can now be disabled or enabled from a new Plugin Manager user
Each extension is composed of one or more plugins, and plugins form the basis of JupyterLab itself,
thus the plugin manager enables more extensive customization of the JupyterLab experience.

<img alt="An example search result in the plugin extension listing" src="https://jupyterlab.readthedocs.io/en/stable/_images/plugin-manager-search-notebook.png" class="jp-screenshot">
<img alt="An example search result in the plugin extension listing" src="https://jupyterlab.readthedocs.io/en/4.1.x/_images/plugin-manager-search-notebook.png" class="jp-screenshot">

This feature is intended for advanced users and is documented in depth in the [documentation](https://jupyterlab.readthedocs.io/en/stable/user/extensions.html#managing-plugins-with-plugin-manager).
This feature is intended for advanced users and is documented in depth in the [documentation](https://jupyterlab.readthedocs.io/en/4.1.x/user/extensions.html#managing-plugins-with-plugin-manager).

Administrators may want to [lock specific plugins](https://jupyterlab.readthedocs.io/en/stable/user/extensions.html#locking-and-unlocking-plugins) if they are required for any reason; this will prevent users from disabling the plugins via Plugin Manager and remote API calls. The Plugin Manager itself can be [disabled using the CLI](https://jupyterlab.readthedocs.io/en/stable/user/extensions.html#enabling-and-disabling-extensions).
Administrators may want to [lock specific plugins](https://jupyterlab.readthedocs.io/en/4.1.x/user/extensions.html#locking-and-unlocking-plugins) if they are required for any reason; this will prevent users from disabling the plugins via Plugin Manager and remote API calls. The Plugin Manager itself can be [disabled using the CLI](https://jupyterlab.readthedocs.io/en/4.1.x/user/extensions.html#enabling-and-disabling-extensions).

### Virtual scrollbar for notebook in windowed mode

Expand Down Expand Up @@ -186,7 +186,7 @@ Developers can now provide editor extensions, like themes and programming langua
#### New extension manager

Starting with JupyterLab 3, extensions can be installed via Python packages
(or other providers of [prebuilt extensions](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html#prebuilt-extensions)).
(or other providers of [prebuilt extensions](https://jupyterlab.readthedocs.io/en/4.1.x/extension/extension_dev.html#prebuilt-extensions)).

In JupyterLab 4, building on this feature, the Extension Manager now includes extensions from [pypi.org](https://pypi.org/search/?c=Framework+%3A%3A+Jupyter+%3A%3A+JupyterLab).
This removes the build step from installation of extension when using Extension Manager.
Expand Down Expand Up @@ -260,7 +260,7 @@ Here are the main tool updates that will benefit extension authors and developer

We recommend using Node.js v18 or newer, because older versions will reach end of life in 2023 or earlier (see [Node release schedule](https://github.com/nodejs/release#release-schedule)).

To ease code migration to JupyterLab 4, developers should review the [migration guide](https://jupyterlab.readthedocs.io/en/stable/extension/extension_migration.html). A few existing extensions have already been migrated and can be used as examples:
To ease code migration to JupyterLab 4, developers should review the [migration guide](https://jupyterlab.readthedocs.io/en/4.1.x/extension/extension_migration.html). A few existing extensions have already been migrated and can be used as examples:
- the [JupyterLab Extensions by Examples](https://github.com/jupyterlab/extension-examples/pull/232)
- the [Jupyter MIME type renderers](https://github.com/jupyterlab/jupyter-renderers/pull/296)

Expand Down Expand Up @@ -1521,9 +1521,9 @@ To ease code migration to JupyterLab 4, developers should review the [migration

JupyterLab 4 is released! :tada:

Check out the new features, improvements and bug fixes: https://jupyterlab.readthedocs.io/en/stable/getting_started/changelog.html#v4-0
Check out the new features, improvements and bug fixes: https://jupyterlab.readthedocs.io/en/4.1.x/getting_started/changelog.html#v4-0

For extension authors, there is a migration guide available to help you migrate your extensions to JupyterLab 4: https://jupyterlab.readthedocs.io/en/stable/extension/extension_migration.html#jupyterlab-3-x-to-4-x
For extension authors, there is a migration guide available to help you migrate your extensions to JupyterLab 4: https://jupyterlab.readthedocs.io/en/4.1.x/extension/extension_migration.html#jupyterlab-3-x-to-4-x

______________________________________________________________________

Expand Down Expand Up @@ -3426,7 +3426,7 @@ No merged PRs

### Enhancements made

- Add a menu entry to show/hide hidden files in the filebrowser [#11206](https://github.com/jupyterlab/jupyterlab/pull/11206) ([@loichuder](https://github.com/loichuder)) - activation instructions: [see documentation](https://jupyterlab.readthedocs.io/en/stable/user/files.html#displaying-hidden-files)
- Add a menu entry to show/hide hidden files in the filebrowser [#11206](https://github.com/jupyterlab/jupyterlab/pull/11206) ([@loichuder](https://github.com/loichuder)) - activation instructions: [see documentation](https://jupyterlab.readthedocs.io/en/4.1.x/user/files.html#displaying-hidden-files)
- Restore Copy shareable link use of `shareUrl` [#11188](https://github.com/jupyterlab/jupyterlab/pull/11188) ([@fcollonval](https://github.com/fcollonval))
- Add Galata in JupyterLab [#11179](https://github.com/jupyterlab/jupyterlab/pull/11179) ([@fcollonval](https://github.com/fcollonval))
- Responsive Toolbar [#11178](https://github.com/jupyterlab/jupyterlab/pull/11178) ([@3coins](https://github.com/3coins))
Expand Down Expand Up @@ -3872,9 +3872,9 @@ No merged PRs
- From JupyterLab 3.1, file documents and notebooks have collaborative
editing using the [Yjs shared editing framework](https://github.com/yjs/yjs).
Editors are not collaborative by default; to activate it, start JupyterLab
with the `--collaborative` flag. See full documentation on [collaboration](https://jupyterlab.readthedocs.io/en/stable/user/rtc.html).
with the `--collaborative` flag. See full documentation on [collaboration](https://jupyterlab.readthedocs.io/en/4.1.x/user/rtc.html).
- The undo/redo history in the notebook is now document-wide (tracking changes across all cells); the future verisions will enable restoring the previous behaviour of per-cell undo/redo.
- Table of Contents recieved multiple new features and settings described in the [user documentation](https://jupyterlab.readthedocs.io/en/stable/user/toc.html).
- Table of Contents recieved multiple new features and settings described in the [user documentation](https://jupyterlab.readthedocs.io/en/4.1.x/user/toc.html).
- The debugger recived many improvements, including basic support for evaluating code at a breakpoint, and for variable inspection.
- The closing bracket is no longer automatically added by default; the old behaviour can be re-enabled from the menu bar (`Settings` -> `Auto Close Brackets`) or from the Advanced Settings Editor.
- A new visual indicator was introduced to highlight cells in which the code changed in the editor since last execution:
Expand Down Expand Up @@ -4495,21 +4495,21 @@ extensions does not require rebuilding JupyterLab and does not require
having NodeJS installed. The previous way of distributing extensions as
npm packages requiring rebuilding JupyterLab is still available as well.
See the
[documentation](https://jupyterlab.readthedocs.io/en/stable/user/extensions.html#extensions)
[documentation](https://jupyterlab.readthedocs.io/en/4.1.x/user/extensions.html#extensions)
for more details.

#### The JupyterLab interface supports multiple languages

JupyterLab now provides the ability to set the display language of the
user interface. See the
[documentation](https://jupyterlab.readthedocs.io/en/stable/user/language.html)
[documentation](https://jupyterlab.readthedocs.io/en/4.1.x/user/language.html)
for more details.

#### A new visual debugger

JupyterLab now ships with a debugger front-end by default, available for
kernels that support the new debugging protocol. See the
[documentation](https://jupyterlab.readthedocs.io/en/stable/user/debugger.html)
[documentation](https://jupyterlab.readthedocs.io/en/4.1.x/user/debugger.html)
for more details.

#### Improvements to Simple Interface mode and Mobile
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ If you're reading this section, you're probably interested in contributing to
JupyterLab. Welcome and thanks for your interest in contributing!

Please take a look at Contributing to Jupyterlab on
[Read the Docs](https://jupyterlab.readthedocs.io/en/stable/developer/contributing.html) or
[Read the Docs](https://jupyterlab.readthedocs.io/en/4.1.x/developer/contributing.html) or
[Repo docs](docs/source/developer/contributing.rst) (for the latest).
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ via [PyPI](https://pypi.org/search/?q=jupyterlab&o=-created&c=Framework+%3A%3A+J
conda, and other package managers. The _source_ extensions can be installed
directly from npm (search for [jupyterlab-extension](https://www.npmjs.com/search?q=keywords:jupyterlab-extension)) but require an additional build step.
You can also find JupyterLab extensions exploring GitHub topic [jupyterlab-extension](https://github.com/topics/jupyterlab-extension).
To learn more about extensions, see the [user documentation](https://jupyterlab.readthedocs.io/en/stable/user/extensions.html).
To learn more about extensions, see the [user documentation](https://jupyterlab.readthedocs.io/en/4.1.x/user/extensions.html).

Read the current JupyterLab documentation on [ReadTheDocs](http://jupyterlab.readthedocs.io/en/stable/).

Expand All @@ -60,7 +60,7 @@ If you use [conda](https://docs.conda.io/en/latest/), [mamba](https://mamba.read
```
If installing using `pip install --user`, you must add the user-level `bin` directory to your `PATH` environment variable in order to launch `jupyter lab`. If you are using a Unix derivative (e.g., FreeBSD, GNU/Linux, macOS), you can do this by running `export PATH="$HOME/.local/bin:$PATH"`. If you are using a macOS version that comes with Python 2, run `pip3` instead of `pip`.

For more detailed instructions, consult the [installation guide](http://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html). Project installation instructions from the git sources are available in the [contributor documentation](CONTRIBUTING.md).
For more detailed instructions, consult the [installation guide](http://jupyterlab.readthedocs.io/en/4.1.x/getting_started/installation.html). Project installation instructions from the git sources are available in the [contributor documentation](CONTRIBUTING.md).

#### Installing with Previous Versions of Jupyter Notebook

Expand All @@ -78,7 +78,7 @@ Start up JupyterLab using:
jupyter lab
```

JupyterLab will open automatically in the browser. See the [documentation](http://jupyterlab.readthedocs.io/en/stable/getting_started/starting.html) for additional details.
JupyterLab will open automatically in the browser. See the [documentation](http://jupyterlab.readthedocs.io/en/4.1.x/getting_started/starting.html) for additional details.

If you encounter an error like "Command 'jupyter' not found", please make sure `PATH` environment variable is set correctly. Alternatively, you can start up JupyterLab using `~/.local/bin/jupyter lab` without changing the `PATH` environment variable.

Expand All @@ -90,7 +90,7 @@ The latest versions of the following browsers are currently _known to work_:
- Chrome
- Safari

See our [documentation](http://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html) for additional details.
See our [documentation](http://jupyterlab.readthedocs.io/en/4.1.x/getting_started/installation.html) for additional details.

---

Expand All @@ -100,7 +100,7 @@ We encourage you to ask questions on the [Discourse forum](https://discourse.jup

### Bug report

To report a bug please read the [guidelines](https://jupyterlab.readthedocs.io/en/stable/getting_started/issue.html) and then open a [Github issue](https://github.com/jupyterlab/jupyterlab/issues/new?labels=bug%2C+status%3ANeeds+Triage&template=bug_report.md). To keep resolved issues self-contained, the [lock bot](https://github.com/apps/lock) will lock closed issues as resolved after a period of inactivity. If a related discussion is still needed after an issue is locked, please open a new issue and reference the old issue.
To report a bug please read the [guidelines](https://jupyterlab.readthedocs.io/en/4.1.x/getting_started/issue.html) and then open a [Github issue](https://github.com/jupyterlab/jupyterlab/issues/new?labels=bug%2C+status%3ANeeds+Triage&template=bug_report.md). To keep resolved issues self-contained, the [lock bot](https://github.com/apps/lock) will lock closed issues as resolved after a period of inactivity. If a related discussion is still needed after an issue is locked, please open a new issue and reference the old issue.

### Feature request

Expand All @@ -112,11 +112,11 @@ We also welcome suggestions for new features as they help make the project more

### Extending JupyterLab

To start developing an extension for JupyterLab, see the [developer documentation](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html) and the [API docs](https://jupyterlab.readthedocs.io/en/stable/api/).
To start developing an extension for JupyterLab, see the [developer documentation](https://jupyterlab.readthedocs.io/en/4.1.x/extension/extension_dev.html) and the [API docs](https://jupyterlab.readthedocs.io/en/4.1.x/api/).

### Contributing

To contribute code or documentation to JupyterLab itself, please read the [contributor documentation](https://jupyterlab.readthedocs.io/en/stable/developer/contributing.html).
To contribute code or documentation to JupyterLab itself, please read the [contributor documentation](https://jupyterlab.readthedocs.io/en/4.1.x/developer/contributing.html).

JupyterLab follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/community/content-community.html).

Expand Down
2 changes: 1 addition & 1 deletion buildutils/src/ensure-repo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ type CoreData = Map<string, any>;
const URL_CONFIG = {
source: 'main',
target: '4.1.x',
rtdVersion: 'stable'
rtdVersion: '4.1.x'
};

// Data to ignore.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/extension/extension_migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ bumped their major version (following semver convention). We want to point out p
``token.findByFileName(widget.context.path)?.name ?? ''``.
- ``@jupyterlab/docprovider`` from 3.x to 4.x
This package is no longer present in JupyterLab. For documentation related to Real-Time Collaboration, please check out
`RTC's documentation <https://jupyterlab.readthedocs.io/en/stable/user/rtc.html>`_
`RTC's documentation <https://jupyterlab.readthedocs.io/en/4.1.x/user/rtc.html>`_
- ``@jupyterlab/docregistry`` from 3.x to 4.x
* Removed the property ``docProviderFactory`` from the interface ``Context.IOptions``.
* The constructor of the class ``DocumentModel`` receives a parameter ``DocumentModel.IOptions``.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/extension/internationalization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To internationalize your extension, the following tasks are required:

Domain are normalized by replacing ``-`` with ``_`` characters.

3. Wraps all translatable strings with one of the `gettext functions <https://jupyterlab.readthedocs.io/en/stable/api/modules/translation.html#translationbundle>`_.
3. Wraps all translatable strings with one of the `gettext functions <https://jupyterlab.readthedocs.io/en/4.1.x/api/modules/translation.html#translationbundle>`_.

Examples:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting_started/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Get Started
===========

`JupyterLab <https://jupyterlab.readthedocs.io/en/stable/>`_ is a next-generation web-based user interface for
`JupyterLab <https://jupyterlab.readthedocs.io/en/4.1.x/>`_ is a next-generation web-based user interface for
`Project Jupyter <https://docs.jupyter.org/en/latest/>`_.

.. image:: ../images/interface-jupyterlab.png
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# User Guide

Use this page to navigate to in-depth guides, tutorials, and how-tos for using [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/).
Use this page to navigate to in-depth guides, tutorials, and how-tos for using [JupyterLab](https://jupyterlab.readthedocs.io/en/4.1.x/).

```{toctree}
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion packages/apputils-extension/src/announcements.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const COMMAND_HELP_OPEN = 'help:open';
const NEWS_API_URL = '/lab/api/news';
const UPDATE_API_URL = '/lab/api/update';
const PRIVACY_URL =
'https://jupyterlab.readthedocs.io/en/stable/privacy_policies.html';
'https://jupyterlab.readthedocs.io/en/4.1.x/privacy_policies.html';

/**
* Call the announcement API
Expand Down
4 changes: 2 additions & 2 deletions packages/extensionmanager/src/widget.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ function ListEntry(props: ListEntry.IProperties): React.ReactElement<any> {
)}
onClick={() =>
window.open(
'https://jupyterlab.readthedocs.io/en/stable/user/extensions.html'
'https://jupyterlab.readthedocs.io/en/4.1.x/user/extensions.html'
)
}
/>
Expand Down Expand Up @@ -415,7 +415,7 @@ to work, this panel needs to fetch data from web services. Do you agree to
activate this feature?`)}
<br />
<a
href="https://jupyterlab.readthedocs.io/en/stable/privacy_policies.html"
href="https://jupyterlab.readthedocs.io/en/4.1.x/privacy_policies.html"
target="_blank"
rel="noreferrer"
>
Expand Down
4 changes: 2 additions & 2 deletions packages/help-extension/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -298,11 +298,11 @@ const resources: JupyterFrontEndPlugin<void> = {
const resources = [
{
text: trans.__('JupyterLab Reference'),
url: 'https://jupyterlab.readthedocs.io/en/stable/'
url: 'https://jupyterlab.readthedocs.io/en/4.1.x/'
},
{
text: trans.__('JupyterLab FAQ'),
url: 'https://jupyterlab.readthedocs.io/en/stable/getting_started/faq.html'
url: 'https://jupyterlab.readthedocs.io/en/4.1.x/getting_started/faq.html'
},
{
text: trans.__('Jupyter Reference'),
Expand Down
2 changes: 1 addition & 1 deletion packages/services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Javascript client for the Jupyter services REST APIs

[API Docs](https://jupyterlab.readthedocs.io/en/stable/api/)
[API Docs](https://jupyterlab.readthedocs.io/en/4.1.x/api/)

[REST API Docs](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter-server/jupyter_server/main/jupyter_server/services/api/api.yaml)

Expand Down
2 changes: 1 addition & 1 deletion packages/ui-components/docs/source/intro.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. Copyright (c) Jupyter Development Team.
.. Distributed under the terms of the Modified BSD License.
The `@jupyterlab/ui-components <https://jupyterlab.readthedocs.io/en/stable/api/modules/ui_components.html>`__
The `@jupyterlab/ui-components <https://jupyterlab.readthedocs.io/en/4.1.x/api/modules/ui_components.html>`__
package provides UI elements that are widely used in JupyterLab core,
and that can be reused in your own extensions.

Expand Down

0 comments on commit ba2431e

Please sign in to comment.