Merge pull request #1321 from willingc/doc-services

Add autodoc of services and update services.auth for OAuth

docs/source/api/app.rst

@@ -2,9 +2,15 @@
 Application configuration
 =========================
 
+Module: :mod:`jupyterhub.app`
+=============================
+
+.. automodule:: jupyterhub.app
+
 .. currentmodule:: jupyterhub.app
 
 :class:`JupyterHub`
 -------------------
 
 .. autoconfigurable:: JupyterHub
+

docs/source/api/auth.rst

@@ -9,13 +9,20 @@ Module: :mod:`jupyterhub.auth`
 
 .. currentmodule:: jupyterhub.auth
 
-
+:class:`Authenticator`
+----------------------
 
 .. autoconfigurable:: Authenticator
     :members:
 
+:class:`LocalAuthenticator`
+---------------------------
+
 .. autoconfigurable:: LocalAuthenticator
     :members:
 
+:class:`PAMAuthenticator`
+-------------------------
+
 .. autoconfigurable:: PAMAuthenticator
 

docs/source/api/index.rst

@@ -1,8 +1,8 @@
 .. _api-index:
 
-####################
- The JupyterHub API
-####################
+##################
+The JupyterHub API
+##################
 
 :Release: |release|
 :Date: |today|
@@ -31,6 +31,7 @@ JupyterHub API Reference:
     spawner
     proxy
     user
+    service
     services.auth
 
 

docs/source/api/proxy.rst

@@ -9,11 +9,15 @@ Module: :mod:`jupyterhub.proxy`
 
 .. currentmodule:: jupyterhub.proxy
 
-
+:class:`Proxy`
+--------------
 
 .. autoconfigurable:: Proxy
     :members:
 
+:class:`ConfigurableHTTPProxy`
+------------------------------
+
 .. autoconfigurable:: ConfigurableHTTPProxy
     :members: debug, auth_token, check_running_interval, api_url, command
 

docs/source/api/service.rst

@@ -0,0 +1,17 @@
+========
+Services
+========
+
+Module: :mod:`jupyterhub.services.service`
+==========================================
+
+.. automodule:: jupyterhub.services.service
+
+.. currentmodule:: jupyterhub.services.service
+
+:class:`Service`
+----------------
+
+.. autoconfigurable:: Service
+    :members: name, admin, url, api_token, managed, kind, command, cwd, environment, user, oauth_client_id, server, prefix, proxy_spec
+

docs/source/api/services.auth.rst

@@ -1,5 +1,5 @@
 =======================
-Authenticating Services
+Services Authentication
 =======================
 
 Module: :mod:`jupyterhub.services.auth`
@@ -10,9 +10,16 @@ Module: :mod:`jupyterhub.services.auth`
 .. currentmodule:: jupyterhub.services.auth
 
 
+:class:`HubAuth`
+----------------
+
 .. autoconfigurable:: HubAuth
     :members:
 
+
+:class:`HubAuthenticated`
+-------------------------
+
 .. autoclass:: HubAuthenticated
     :members:
 

docs/source/api/spawner.rst

@@ -1,6 +1,6 @@
-==============
-   Spawners
-==============
+========
+Spawners
+========
 
 Module: :mod:`jupyterhub.spawner`
 =================================
@@ -15,4 +15,8 @@ Module: :mod:`jupyterhub.spawner`
 .. autoconfigurable:: Spawner
     :members: options_from_form, poll, start, stop, get_args, get_env, get_state, template_namespace, format_string
 
+:class:`LocalProcessSpawner`
+----------------------------
+
 .. autoconfigurable:: LocalProcessSpawner
+

docs/source/api/user.rst

@@ -1,6 +1,6 @@
-=============
-   Users
-=============
+=====
+Users
+=====
 
 Module: :mod:`jupyterhub.user`
 ==============================
@@ -9,11 +9,16 @@ Module: :mod:`jupyterhub.user`
 
 .. currentmodule:: jupyterhub.user
 
+:class:`UserDict`
+-----------------
+
+.. autoclass:: UserDict
+    :members:
+
+
 :class:`User`
 -------------
 
-.. class:: Server
-
 .. autoclass:: User
     :members: escaped_name
     
@@ -29,3 +34,4 @@ Module: :mod:`jupyterhub.user`
     .. attribute:: spawner
     
         The user's :class:`~.Spawner` instance.
+