From bf59efac848edb5afe580b62406500fdc86dbe55 Mon Sep 17 00:00:00 2001 From: Thierry Parmentelat Date: Sun, 17 Sep 2023 11:27:56 +0200 Subject: [PATCH] clarify that the classic version is obsolete and redirect jlab users to jupyterlab-rise fix #644 --- doc/changelog.rst | 17 +++++++++++++++++ doc/dev/develop.md | 4 +++- doc/dev/release.md | 3 +++ doc/usage.md | 12 ++++++++---- 4 files changed, 31 insertions(+), 5 deletions(-) diff --git a/doc/changelog.rst b/doc/changelog.rst index a9d4b03a..cbaca712 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -1,6 +1,17 @@ Changelog --------- +END OF LIFE +=========== + +* RISE only supports notebook classic, which is now obsolete +* consequently RISE is now officially deprecated and will not be maintained anymore +* Please use instead the new JupyterLab extension: + ```bash + pip install jupyterlab-rise + ``` +* github repo here https://github.com/jupyterlab-contrib/rise + Versions ======== @@ -27,12 +38,18 @@ Versions * 5.6.1 tag compatible with `notebook` >= 6.0.0 * 5.7.0 tag compatible with `notebook` >= 6.0.0 * 5.7.1 tag compatible with `notebook` >= 6.0.0 + * **NOTE** no version of RISE is compatible with `notebook` >= 7.0.0 You will also find tags for "development" releases (mostly beta and rc we release before the "official" releases). Changes ======= +* 5.7.2 + + * never released as a stable package; mostly this extension is now deprecated + and we are working on a new JupyterLab extension - see above + * 5.7.1 * Adding color support to the chalkboard (https://github.com/damianavila/RISE/pull/567) diff --git a/doc/dev/develop.md b/doc/dev/develop.md index 1afc07d7..2abe8381 100644 --- a/doc/dev/develop.md +++ b/doc/dev/develop.md @@ -5,7 +5,9 @@ in a nutshell, 5.7 comes with a clear separation between * what is inherited from `reveal.js` with our minor adaptations (the `rise-reveal` subdir), * the RISE extension for the classic notebook (the `classic` subdir), -* opening the space for a future `jlab` subdir that will host the jupyterlab extension. +* opening the space for a future `jlab/` subdir that will host the jupyterlab extension. + however be aware that the official JupyterLab RISE extensions eventually landed + in a separate github repo at **** diff --git a/doc/dev/release.md b/doc/dev/release.md index 6b8159ac..63d5d95d 100644 --- a/doc/dev/release.md +++ b/doc/dev/release.md @@ -7,6 +7,9 @@ for the classic notebook extension has moved under the `classic` subdir; at this `jlab` area is not ready for shipping, and so these instructions are **only about the classic extension**. +**NOTE** be aware that the official JupyterLab RISE extensions eventually landed + in a separate github repo at + ### Pre-Release check **Step 0.** Clean your local repo copy at your top level (ROOT) directory: diff --git a/doc/usage.md b/doc/usage.md index c23e38b1..52135749 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -120,8 +120,12 @@ You should press the `t` key to open the speaker notes view. ### JupyterLab -Please be aware that as of 5.3 RISE is unfortunately not yet -compatible with JupyterLab and must be used with the classic notebook. +Please be aware that the extension built from this repo is not compatible with JupyterLab +and must be used with the classic notebook. -See for the github -issue on this topic. +JupyterLab users are encouraged to use the RISE JupyterLab extension instead +```bash +pip install jupyterlab-rise +``` + +see also the github repo here