Skip to content

Commit 8e8c113

Browse files
docs: add examples of Jupyter Server extensions
1 parent 19498e8 commit 8e8c113

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

docs/source/developers/extensions.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,13 @@ Server Extensions
66

77
A Jupyter Server extension is typically a module or package that extends to Server’s REST API/endpoints—i.e. adds extra request handlers to Server’s Tornado Web Application.
88

9-
You can check some simple examples on the `examples folder
9+
For examples of jupyter server extensions, see the
10+
:ref:`homepage <examples of jupyter server extensions>`.
11+
12+
To get started writing your own extension, see the simple examples in the `examples folder
1013
<https://github.com/jupyter/jupyter_server/tree/main/examples/simple>`_ in the GitHub jupyter_server repository.
1114

15+
1216
Authoring a basic server extension
1317
==================================
1418

docs/source/index.rst

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ You've landed on the documentation pages for the **Jupyter Server** Project. Som
1111
Introduction
1212
------------
1313

14-
Jupyter Server is the backend—the core services, APIs, and `REST endpoints`_—to Jupyter web applications.
14+
Jupyter Server is the backend that provides the core services, APIs, and
15+
`REST endpoints`_ for Jupyter web applications.
1516

1617
.. note::
1718

@@ -21,6 +22,34 @@ Jupyter Server is the backend—the core services, APIs, and `REST endpoints`_
2122
.. _Jupyter Notebook: https://github.com/jupyter/notebook
2223
.. _REST endpoints: https://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyter_server/main/jupyter_server/services/api/api.yaml
2324

25+
26+
Applications
27+
------------
28+
29+
Jupyter Server extensions can use the framework and services provided by
30+
Jupyter Server to create applications and services.
31+
32+
Examples of Jupyter Server extensions include:
33+
34+
.. _examples of jupyter server extensions:
35+
36+
`Jupyter Lab <https://jupyterlab.readthedocs.io>`_
37+
JupyterLab computational environment.
38+
`Jupyter Resource Usage <https://github.com/jupyter-server/jupyter-resource-usage>`_
39+
Jupyter Notebook Extension for monitoring your own resource usage.
40+
`Jupyter Scheduler <https://jupyter-scheduler.readthedocs.io>`_
41+
Run Jupyter notebooks as jobs.
42+
`jupyter-collaboration <https://jupyterlab-realtime-collaboration.readthedocs.io>`_
43+
A Jupyter Server Extension Providing Support for Y Documents.
44+
`NbClassic <https://jupyterlab.readthedocs.io>`_
45+
Jupyter notebook as a Jupyter Server extension.
46+
`Cylc UI Server <https://cylc.org>`_
47+
A Jupyter Server extension that serves the cylc-ui web application for
48+
monitoring and controlling Cylc workflows.
49+
50+
For more information on extensions, see :ref:`extensions`.
51+
52+
2453
Who's this for?
2554
---------------
2655

@@ -33,6 +62,7 @@ The Jupyter Server is a highly technical piece of the Jupyter Stack, so we've se
3362

3463
If you finds gaps in our documentation, please open an issue (or better, a pull request) on the Jupyter Server `Github repo <https://github.com/jupyter/jupyter_server>`_.
3564

65+
3666
Table of Contents
3767
-----------------
3868

0 commit comments

Comments
 (0)