Update autodoc doc files

This commit is contained in:
Carol Willing
2017-08-07 11:02:25 -07:00
parent 95175155d4
commit 024fd07ec8
8 changed files with 40 additions and 13 deletions

View File

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

View File

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

View File

@@ -1,8 +1,8 @@
.. _api-index: .. _api-index:
#################### ##################
The JupyterHub API The JupyterHub API
#################### ##################
:Release: |release| :Release: |release|
:Date: |today| :Date: |today|

View File

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

View File

@@ -14,3 +14,4 @@ Module: :mod:`jupyterhub.services.service`
.. autoconfigurable:: Service .. autoconfigurable:: Service
:members: :members:

View File

@@ -22,3 +22,4 @@ Module: :mod:`jupyterhub.services.auth`
.. autoclass:: HubAuthenticated .. autoclass:: HubAuthenticated
:members: :members:

View File

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

View File

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