Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Zsailer committed Mar 24, 2020
1 parent 36eb1ab commit 1b992cb
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 11 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ To run the Python tests, use::

pytest

Building the Documentation
==========================
Building the Docs
=================

To build the documentation you'll need `Sphinx <http://www.sphinx-doc.org/en/master/>`_,
`pandoc <https://pandoc.org/>`_ and a few other packages.
Expand Down
12 changes: 12 additions & 0 deletions docs/source/contributors/team-meetings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Team Meetings and Road Map
==========================

Many of the lead Jupyter Server developers meet weekly over Zoom. These meetings are open to everyone.

To see when the next meeting is happening, watch this Github issue:

https://github.com/jupyter/jupyter_server/issues/126

Also check out Jupyter Server's roadmap where we track future plans for Jupyter Server:

https://github.com/jupyter/jupyter_server/issues/127
2 changes: 2 additions & 0 deletions docs/source/developers/basic-extension.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Authoring a basic server extension
==================================
9 changes: 3 additions & 6 deletions docs/source/developers/configurable-extension.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
Creating a configurable, Jupyter Server extension
=================================================
Authoring a configurable, server extension application
======================================================

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.

Writing an extension application
--------------------------------

Jupyter Server provides two key classes for writing a server extension:

- ``ExtensionApp``
- ``ExtensionHandlerMixin``
Jupyter Server provides two key classes for writing a server extension: i) ``ExtensionApp`` and ii) ``ExtensionHandlerMixin``

The ExtensionApp:

Expand Down
2 changes: 2 additions & 0 deletions docs/source/developers/dependency.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@ To install the latest patch of a given version:
To pin your jupyter_server install to a specific version:

.. code-block:: console
> pip install jupyter_server==1.0
6 changes: 4 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,19 @@ The Jupyter Server is a highly technical piece of the Jupyter Stack. Since most
:name: developers

developers/dependency
developers/frontends
developers/basic-extension
developers/configurable-extension
developers/rest-api
changelog

.. toctree::
:caption: Contributors
:maxdepth: 1
:name: contributors

contributors/team-meetings
contributors/contributing


.. - Depending on Jupyter Server
.. - Migrating a Notebook server extension to Jupyter Server
.. - Writing a basic server extension from scratch
Expand Down
2 changes: 1 addition & 1 deletion docs/source/users/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Configuring a Jupyter Server

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:

.. code-block:: bash
.. code-block:: console
> jupyter --paths
Expand Down

0 comments on commit 1b992cb

Please sign in to comment.