Skip to content

Commit 1b992cb

Browse files
committed
more docs
1 parent 36eb1ab commit 1b992cb

File tree

7 files changed

+26
-11
lines changed

7 files changed

+26
-11
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ To run the Python tests, use::
6161

6262
pytest
6363

64-
Building the Documentation
65-
==========================
64+
Building the Docs
65+
=================
6666

6767
To build the documentation you'll need `Sphinx <http://www.sphinx-doc.org/en/master/>`_,
6868
`pandoc <https://pandoc.org/>`_ and a few other packages.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Team Meetings and Road Map
2+
==========================
3+
4+
Many of the lead Jupyter Server developers meet weekly over Zoom. These meetings are open to everyone.
5+
6+
To see when the next meeting is happening, watch this Github issue:
7+
8+
https://github.com/jupyter/jupyter_server/issues/126
9+
10+
Also check out Jupyter Server's roadmap where we track future plans for Jupyter Server:
11+
12+
https://github.com/jupyter/jupyter_server/issues/127
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Authoring a basic server extension
2+
==================================

docs/source/developers/configurable-extension.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
1-
Creating a configurable, Jupyter Server extension
2-
=================================================
1+
Authoring a configurable, server extension application
2+
======================================================
33

44
Jupyter Server offers a base class, ``ExtensionApp``, for authoring configurable Jupyter Server extensions. This class handles most of the boilerplate code for setting up config, CLI, and registration with Jupyter Server.
55

66
Writing an extension application
77
--------------------------------
88

9-
Jupyter Server provides two key classes for writing a server extension:
10-
11-
- ``ExtensionApp``
12-
- ``ExtensionHandlerMixin``
9+
Jupyter Server provides two key classes for writing a server extension: i) ``ExtensionApp`` and ii) ``ExtensionHandlerMixin``
1310

1411
The ExtensionApp:
1512

docs/source/developers/dependency.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,6 @@ To install the latest patch of a given version:
1616
1717
To pin your jupyter_server install to a specific version:
1818

19+
.. code-block:: console
20+
1921
> pip install jupyter_server==1.0

docs/source/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,19 @@ The Jupyter Server is a highly technical piece of the Jupyter Stack. Since most
4747
:name: developers
4848

4949
developers/dependency
50-
developers/frontends
50+
developers/basic-extension
51+
developers/configurable-extension
5152
developers/rest-api
53+
changelog
5254

5355
.. toctree::
5456
:caption: Contributors
5557
:maxdepth: 1
5658
:name: contributors
5759

60+
contributors/team-meetings
5861
contributors/contributing
5962

60-
6163
.. - Depending on Jupyter Server
6264
.. - Migrating a Notebook server extension to Jupyter Server
6365
.. - Writing a basic server extension from scratch

docs/source/users/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Configuring a Jupyter Server
33

44
By default, Jupyter Server looks for server-specific configuration in a ``jupyter_server_config.py|json`` file located on a Jupyter path. To list the possible paths, run:
55

6-
.. code-block:: bash
6+
.. code-block:: console
77
88
> jupyter --paths
99

0 commit comments

Comments
 (0)