Make LabConfig configurable and add config API docs (#172)

Author: afshin

docs/source/api/config.rst

@@ -0,0 +1,25 @@
+=========================
+JupyterLab Server Config
+=========================
+
+Module: :mod:`jupyterlab_server.config`
+=======================================
+
+.. automodule:: jupyterlab_server.config
+
+.. currentmodule:: jupyterlab_server.config
+
+.. autofunction:: get_package_url
+
+.. autofunction:: get_federated_extensions
+
+.. autofunction:: get_static_page_config
+
+.. autofunction:: get_page_config
+
+.. autofunction:: write_page_config
+
+:class:`LabConfig`
+---------------------
+
+.. autoconfigurable:: LabConfig

docs/source/api/index.rst

@@ -6,4 +6,4 @@ JupyterLab Server API Reference:
 
 .. toctree::
     app
-
+    config

jupyterlab_server/config.py

@@ -185,66 +185,66 @@ def write_page_config(page_config, level='all'):
 class LabConfig(HasTraits):
     """The lab application configuration object.
     """
-    app_name = Unicode('', help='The name of the application.')
+    app_name = Unicode('', help='The name of the application.').tag(config=True)
 
-    app_version = Unicode('', help='The version of the application.')
+    app_version = Unicode('', help='The version of the application.').tag(config=True)
 
-    app_namespace = Unicode('', help='The namespace of the application.')
+    app_namespace = Unicode('', help='The namespace of the application.').tag(config=True)
 
-    app_url = Unicode('/lab', help='The url path for the application.')
+    app_url = Unicode('/lab', help='The url path for the application.').tag(config=True)
 
-    app_settings_dir = Unicode('', help='The application settings directory.')
+    app_settings_dir = Unicode('', help='The application settings directory.').tag(config=True)
 
     extra_labextensions_path = List(Unicode(),
         help="""Extra paths to look for federated JupyterLab extensions"""
-    )
+    ).tag(config=True)
 
-    labextensions_path = List(Unicode(), help='The standard paths to look in for federated JupyterLab extensions')
+    labextensions_path = List(Unicode(), help='The standard paths to look in for federated JupyterLab extensions').tag(config=True)
 
-    templates_dir = Unicode('', help='The application templates directory.')
+    templates_dir = Unicode('', help='The application templates directory.').tag(config=True)
 
     static_dir = Unicode('',
                          help=('The optional location of local static files. '
                                'If given, a static file handler will be '
-                               'added.'))
+                               'added.')).tag(config=True)
 
 
-    labextensions_url = Unicode('', help='The url for federated JupyterLab extensions')
+    labextensions_url = Unicode('', help='The url for federated JupyterLab extensions').tag(config=True)
 
-    settings_url = Unicode(help='The url path of the settings handler.')
+    settings_url = Unicode(help='The url path of the settings handler.').tag(config=True)
 
     user_settings_dir = Unicode('',
                                 help=('The optional location of the user '
-                                      'settings directory.'))
+                                      'settings directory.')).tag(config=True)
 
     schemas_dir = Unicode('',
                           help=('The optional location of the settings '
                                 'schemas directory. If given, a handler will '
-                                'be added for settings.'))
+                                'be added for settings.')).tag(config=True)
 
-    workspaces_api_url = Unicode(help='The url path of the workspaces API.')
+    workspaces_api_url = Unicode(help='The url path of the workspaces API.').tag(config=True)
 
     workspaces_dir = Unicode('',
                              help=('The optional location of the saved '
                                    'workspaces directory. If given, a handler '
-                                   'will be added for workspaces.'))
+                                   'will be added for workspaces.')).tag(config=True)
 
-    listings_url = Unicode(help='The listings url.')
+    listings_url = Unicode(help='The listings url.').tag(config=True)
 
-    themes_url = Unicode(help='The theme url.')
+    themes_url = Unicode(help='The theme url.').tag(config=True)
 
     themes_dir = Unicode('',
                          help=('The optional location of the themes '
                                'directory. If given, a handler will be added '
-                               'for themes.'))
+                               'for themes.')).tag(config=True)
 
-    translations_api_url = Unicode(help='The url path of the translations handler.')
+    translations_api_url = Unicode(help='The url path of the translations handler.').tag(config=True)
 
-    tree_url = Unicode(help='The url path of the tree handler.')
+    tree_url = Unicode(help='The url path of the tree handler.').tag(config=True)
 
     cache_files = Bool(True,
                        help=('Whether to cache files on the server. '
-                             'This should be `True` except in dev mode.'))
+                             'This should be `True` except in dev mode.')).tag(config=True)
 
     @default('template_dir')
     def _default_template_dir(self):