Add cli config options documentation (#176)

* Add cli config options documentation

* Update RTD config

* Update autogen_config.py

Author: jtpio

.gitignore

@@ -20,3 +20,6 @@ __pycache__
 
 # generated changelog
 docs/source/changelog.md
+
+# generated cli docs
+docs/source/api/app-config.rst

docs/autogen_config.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+
+import os
+from jupyterlab_server import LabServerApp
+
+header = """\
+.. _api-full-config:
+
+
+Config file and command line options
+====================================
+
+The JupyterLab Server can be run with a variety of command line arguments.
+A list of available options can be found below in the :ref:`options section
+<options>`.
+
+Defaults for these options can also be set by creating a file named
+``jupyter_jupyterlab_server_config.py`` in your Jupyter folder. The Jupyter
+folder is in your home directory, ``~/.jupyter``.
+
+To create a ``jupyter_jupyterlab_server_config.py`` file, with all the defaults
+commented out, you can use the following command line::
+
+  $ python -m jupyterlab_server --generate-config
+
+
+.. _options:
+
+Options
+-------
+
+This list of options can be generated by running the following and hitting
+enter::
+
+  $ python -m jupyterlab_server --help-all
+
+"""
+# Handle local and RTD locations
+cwd = os.getcwd()
+if os.path.basename(cwd) == 'source':
+    destination = os.path.join(cwd, 'api/app-config.rst')
+else:
+    destination = os.path.join(cwd, 'source/api/app-config.rst')
+
+with open(destination, 'w') as f:
+    f.write(header)
+    f.write(LabServerApp().document_config_options())

docs/source/api/index.rst

@@ -9,5 +9,6 @@ JupyterLab Server API Reference:
     :caption: Contents:
 
     app
+    app-config
     config
     rest

docs/source/conf.py

@@ -36,7 +36,6 @@
 # The full version, including alpha/beta/rc tags.
 release = version_ns['__version__']
 
-
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -90,3 +89,5 @@
 def setup(app):
     dest = osp.join(HERE, 'changelog.md')
     shutil.copy(osp.join(HERE, '..', '..', 'CHANGELOG.md'), dest)
+    with open(osp.join(HERE, '../autogen_config.py')) as f:
+        exec(compile(f.read(), '../autogen_config.py', 'exec'), {})

jupyterlab_server/__main__.py

@@ -0,0 +1,5 @@
+
+from jupyterlab_server.app import main
+import sys
+
+sys.exit(main())

readthedocs.yml

@@ -1,6 +1,12 @@
-
 version: 2
 sphinx:
   configuration: docs/source/conf.py
 conda:
   environment: docs/environment.yml
+python:
+  version: 3.8
+  install:
+    # install jupyterlab_server itself
+    - method: pip
+      path: .
+