Skip to content

Commit 6e10282

Browse files
committed
updating docs with info for solo nbclassic install
1 parent 8808a29 commit 6e10282

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

docs/source/nbclassic.rst

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,11 @@ Jupyter Ecosystem in this `team-compass issue`_.
6565
You can install NbClassic, Notebook 7 and JupyterLab, all three of
6666
which will be providing different user interfaces that will be available
6767
on the same server. When Notebook 7 is available, the NbClassic UI, will
68-
be served at the ``/nbclassic/tree`` base URL rather than the
69-
base URL ``/tree`` used otherwise. If you are using Notebook 7 along
68+
be served at the ``/nbclassic/tree`` base path rather than the
69+
base path ``/tree`` used otherwise. If you are using Notebook 7 along
7070
with NbClassic, you wil also have JupyterLab installed as it is a
7171
dependency of Notebook 7, and these front ends will be available
72-
through the following base URLs: JupyterLab at ``/lab``, Notebook 7 at
72+
through the following base paths: JupyterLab at ``/lab``, Notebook 7 at
7373
``/tree``, and NbClassic at ``/nbclassic/tree``.
7474

7575
**NbClassic and Notebook 6.5.x**
@@ -78,8 +78,8 @@ As NbClassic provides the static assets for Notebook 6.5.x, while
7878
having both installed should cause no issues, the user interface provided
7979
by these two packages will be the same. These UIs would be available in
8080
different servers. An NbClassic instance will be at a server with the
81-
``/tree`` URL and opening a Notebook 6.5.x instance will open on a
82-
different server with the ``/tree`` URL as well, presenting the same
81+
``/tree`` path and opening a Notebook 6.5.x instance will open on a
82+
different server with the ``/tree`` path as well, presenting the same
8383
static assets. When starting an instance of JupyterLab you will be able
8484
to access the classic view of Notebook with NbClassic served on the same
8585
server at ``/tree``.
@@ -107,6 +107,17 @@ When only JupyterLab 4.x is installed, then NbClassic has to be installed
107107
explictly. They will run on the same server, and are reachable via
108108
``/tree`` for NbClassic, and ``/lab`` for JupyterLab.
109109

110+
**NbClassic Independently**
111+
112+
When you choose to install only NbClassic via ``pip install nbclassic``,
113+
the classic Notebook UI will be presented at the ``/tree`` path. As the
114+
other frontends are not installed, attempting to access the other paths
115+
will return errors. Note that NbClassic being a Jupyter Server extension,
116+
indicated Jupyter Server will be available. This provides an additional
117+
way to view the NbClassic frontend. You would be able to manually
118+
enable the extension when running an instance of Jupyter Server,
119+
``> jupyter server --ServerApp.jpserver_extensions="nbclassic=True"``,
120+
which will provide the NbClassic frontend at ``/tree`` path when visited.
110121

111122
.. _team-compass issue: https://github.com/jupyter/notebook-team-compass/issues/5#issuecomment-1085254000
112123

0 commit comments

Comments
 (0)