Skip to content

Commit 0c888ae

Browse files
Improve the documentation for Notebook 7 (#6813)
* [pre-commit.ci] pre-commit autoupdate (#6814) updates: - [github.com/python-jsonschema/check-jsonschema: 0.21.0 → 0.22.0](python-jsonschema/check-jsonschema@0.21.0...0.22.0) - [github.com/psf/black: 23.1.0 → 23.3.0](psf/black@23.1.0...23.3.0) - [github.com/charliermarsh/ruff-pre-commit: v0.0.254 → v0.0.260](astral-sh/ruff-pre-commit@v0.0.254...v0.0.260) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Add note and warning on the extension landing page * fix nbclassic url * fix seealso blocks * Fix note * add changelog to the navbar * update faq * Update screencasts and screenshots * Remove old screenshots and screencasts * rename migrating file * Split the migration guide * dedicate a page to new features * document themes * Iterate on the new features * expand docs on extensions * add Binder link * mention the interface dropdown * iterate on features * Mention nbgrader and RISE * Lint * Add server extension docs * fixes --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 65da1cd commit 0c888ae

20 files changed

+353
-455
lines changed
-24.6 KB
Binary file not shown.

docs/source/_static/images/blank-notebook-ui.svg

Lines changed: 0 additions & 397 deletions
This file was deleted.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
-518 KB
Binary file not shown.

docs/source/development_faq.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44

55
1. How do I install a prerelease version such as a beta or release candidate?
66

7+
You can install a prerelease version of the notebook using the `--pre` flag with `pip`:
8+
79
```bash
810
python -m pip install notebook --pre --upgrade
911
```
12+
13+
If you are using `conda` or `mamba`, you can install a prerelease version of the notebook using the alpha or beta label. For example, to install the latest alpha release, you can run:
14+
15+
```bash
16+
conda install -c conda-forge -c conda-forge/label/notebook_alpha notebook=7.0.0a18
17+
```

docs/source/extending/frontend_extensions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ This describes the basic steps to write a TypeScript extension for the Jupyter
66
notebook front-end. This allows you to customize the behaviour of the various
77
pages like the dashboard, the notebook, or the text editor.
88

9-
Starting with Notebook v7, front-end extensions for the notebook can be developed
9+
Starting with Notebook 7, front-end extensions for the notebook can be developed
1010
as prebuilt JupyterLab extensions.
1111

12-
This means Notebook v7 is able to reuse many of the existing extensions from the JupyterLab ecosystem as is.
12+
This means Notebook 7 is able to reuse many of the existing extensions from the JupyterLab ecosystem as is.
1313

14-
If you would like to develop a prebuilt extension for Notebook v7, check out:
14+
If you would like to develop a prebuilt extension for Notebook 7, check out:
1515

1616
- [JupyterLab Extension Tutorial](https://jupyterlab.readthedocs.io/en/latest/extension/extension_tutorial.html): A tutorial to learn how to make a simple JupyterLab extension.
17-
- The [JupyterLab Extension Examples Repository](https://github.com/jupyterlab/extension-examples): A short tutorial series to learn how to develop extensions for JupyterLab by example.
17+
- The [JupyterLab Extension Examples Repository](https://github.com/jupyterlab/extension-examples): A repository containing many examples of JupyterLab extensions for performing various tasks: adding commands, adding a new widget, handling user settings, etc.

docs/source/extending/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# Extending the Notebook
22

3+
```{warning}
4+
Please note that the extension system for Notebook 7 is radically different
5+
from the one used in Notebook 6.5.x and earlier. If you are looking for
6+
information on how to extend the classic Notebook, please refer to the
7+
[documentation for NbClassic](https://nbclassic.readthedocs.io/en/latest/extending/index.html).
8+
```
9+
10+
```{note}
11+
With Notebook 7 being developed on top of JupyterLab and Jupyter Server, the
12+
frontend extension system is now based on the same extension system used by JupyterLab.
13+
14+
Server extensions are also now based on the same system used by Jupyter Server.
15+
You will find below a link to the relevant documentations.
16+
```
17+
318
Certain subsystems of the notebook server are designed to be extended or
419
overridden by users. These documents explain these systems, and show how to
520
override the notebook's defaults with your own custom behavior.

0 commit comments

Comments
 (0)