Add more API docs (#177)

Author: jtpio

docs/source/api/handlers.rst

@@ -0,0 +1,80 @@
+========
+Handlers
+========
+
+Module: :mod:`jupyterlab_server.handlers`
+=========================================
+
+.. automodule:: jupyterlab_server.handlers
+
+.. currentmodule:: jupyterlab_server.handlers
+
+.. autoclass:: LabHandler
+    :members:
+
+.. autofunction:: add_handlers
+
+.. autofunction:: is_url
+
+
+Module: :mod:`jupyterlab_server.listings_handler`
+=================================================
+
+.. automodule:: jupyterlab_server.listings_handler
+
+.. currentmodule:: jupyterlab_server.listings_handler
+
+.. autoclass:: ListingsHandler
+    :members:
+
+.. autofunction:: fetch_listings
+
+
+Module: :mod:`jupyterlab_server.settings_handler`
+=================================================
+
+.. automodule:: jupyterlab_server.settings_handler
+
+.. currentmodule:: jupyterlab_server.settings_handler
+
+.. autoclass:: SettingsHandler
+    :members:
+
+.. autofunction:: get_settings
+
+
+Module: :mod:`jupyterlab_server.themes_handler`
+=================================================
+
+.. automodule:: jupyterlab_server.themes_handler
+
+.. currentmodule:: jupyterlab_server.themes_handler
+
+.. autoclass:: ThemesHandler
+    :members:
+
+
+Module: :mod:`jupyterlab_server.translations_handler`
+=====================================================
+
+.. automodule:: jupyterlab_server.translations_handler
+
+.. currentmodule:: jupyterlab_server.translations_handler
+
+.. autoclass:: TranslationsHandler
+    :members:
+
+.. autofunction:: get_current_locale
+
+
+Module: :mod:`jupyterlab_server.workspaces_handler`
+=====================================================
+
+.. automodule:: jupyterlab_server.workspaces_handler
+
+.. currentmodule:: jupyterlab_server.workspaces_handler
+
+.. autoclass:: WorkspacesHandler
+    :members:
+
+.. autofunction:: slugify

docs/source/api/index.rst

@@ -8,7 +8,9 @@ JupyterLab Server API Reference:
     :maxdepth: 1
     :caption: Contents:
 
-    app
     app-config
+    app
     config
+    handlers
+    process
     rest

docs/source/api/process.rst

@@ -0,0 +1,31 @@
+=======
+Process
+=======
+
+Module: :mod:`jupyterlab_server.process`
+========================================
+
+.. automodule:: jupyterlab_server.process
+
+.. currentmodule:: jupyterlab_server.process
+
+.. autoclass:: Process
+    :members:
+
+.. autoclass:: WatchHelper
+    :members:
+
+.. autofunction:: which
+
+
+Module: :mod:`jupyterlab_server.process_app`
+============================================
+
+.. automodule:: jupyterlab_server.process_app
+
+.. currentmodule:: jupyterlab_server.process_app
+
+:class:`ProcessApp`
+-------------------
+
+.. autoconfigurable:: ProcessApp

docs/source/conf.py

@@ -43,6 +43,7 @@
 # ones.
 extensions = [
     'myst_parser',
+    'numpydoc',
     'autodoc_traits',
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
@@ -71,20 +72,22 @@
 #
 html_theme = "pydata_sphinx_theme"
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# Add an Edit this Page button
+html_theme_options = {
+    "use_edit_page_button": True,
+}
 
 # Output for github to be used in links
 html_context = {
-    "display_github": True,  # Integrate GitHub
     "github_user": "jupyterlab",  # Username
     "github_repo": "jupyterlab_server",  # Repo name
     "github_version": "master",  # Version
-    "conf_py_path": "/docs/source/",  # Path in the checkout to the docs root
+    "doc_path": "/docs/source/",  # Path in the checkout to the docs root
 }
 
+# This option generates errors when methods do not have docstrings,
+# so disable
+numpydoc_show_class_members = False
 
 def setup(app):
     dest = osp.join(HERE, 'changelog.md')

jupyterlab_server/config.py

@@ -69,8 +69,8 @@ def get_federated_extensions(labextensions_path):
 def get_static_page_config(app_settings_dir=None, logger=None, level='all'):
     """Get the static page config for JupyterLab
 
-    Params
-    ------
+    Parameters
+    ----------
     logger: logger, optional
         An optional logging object
     level: string, optional ['all']

jupyterlab_server/handlers.py

@@ -59,6 +59,7 @@ class LabHandler(ExtensionHandlerJinjaMixin, ExtensionHandlerMixin, JupyterHandl
     @web.authenticated
     @web.removeslash
     def get(self, mode = None, workspace = None, tree = None):
+        """Get the JupyterLab html page."""
         workspace = 'default' if workspace is None else workspace.replace('/workspaces/','')
         tree_path = '' if tree is None else tree.replace('/tree/','')
 

jupyterlab_server/listings_handler.py

@@ -14,6 +14,7 @@
 
 
 def fetch_listings(logger):
+    """Fetch the listings for the extension manager."""
     if not logger:
         from traitlets import log
         logger = log.get_logger()
@@ -68,6 +69,7 @@ class ListingsHandler(APIHandler):
 
 
     def get(self, path):
+        """Get the listings for the extension manager."""
         self.set_header('Content-Type', 'application/json')
         if path == LISTINGS_URL_SUFFIX:
             self.write(ListingsHandler.listings)

jupyterlab_server/settings_handler.py

@@ -299,7 +299,7 @@ def get_settings(app_settings_dir, schemas_dir, settings_dir, schema_name="", ov
         The first item is a dictionary with a list of setting if no `schema_name`
         was provided, otherwise it is a dictionary with id, raw, scheme, settings
         and version keys. The second item is a list of warnings. Warnings will
-        either be a list of i) strings with the warning messages or ii) `None`s.
+        either be a list of i) strings with the warning messages or ii) `None`.
     """
     result = {}
     warnings = []
@@ -342,6 +342,7 @@ def initialize(self, name, app_settings_dir, schemas_dir, settings_dir, labexten
 
     @web.authenticated
     def get(self, schema_name=""):
+        """Get setting(s)"""
         result, warnings = get_settings(
             self.app_settings_dir,
             self.schemas_dir,
@@ -360,6 +361,7 @@ def get(self, schema_name=""):
 
     @web.authenticated
     def put(self, schema_name):
+        """Update a setting"""
         overrides = self.overrides
         schemas_dir = self.schemas_dir
         settings_dir = self.settings_dir

jupyterlab_server/workspaces_handler.py

@@ -101,14 +101,15 @@ def initialize(self, name, path, workspaces_url=None, **kwargs):
         self.workspaces_dir = path
 
     def ensure_directory(self):
-        """Return the workspaces directory if set or raise error if not set."""
+        """Return the workspaces directory if set or raise error if not set"""
         if not self.workspaces_dir:
             raise web.HTTPError(500, 'Workspaces directory is not set')
 
         return self.workspaces_dir
 
     @web.authenticated
     def delete(self, space_name):
+        """Remove a workspace"""
         directory = self.ensure_directory()
 
         if not space_name:
@@ -129,6 +130,7 @@ def delete(self, space_name):
 
     @web.authenticated
     def get(self, space_name=''):
+        """Get workspace(s) data"""
         directory = self.ensure_directory()
 
         if not space_name:
@@ -153,6 +155,7 @@ def get(self, space_name=''):
 
     @web.authenticated
     def put(self, space_name=''):
+        """Update workspace data"""
         if not space_name:
             raise web.HTTPError(400, 'Workspace name is required for PUT.')