mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-17 23:13:00 +00:00
Update autodoc doc files
This commit is contained in:
@@ -2,9 +2,13 @@
|
||||
Application configuration
|
||||
=========================
|
||||
|
||||
Module: :mod:`jupyterhub.app`
|
||||
=============================
|
||||
|
||||
.. currentmodule:: jupyterhub.app
|
||||
|
||||
:class:`JupyterHub`
|
||||
-------------------
|
||||
|
||||
.. autoconfigurable:: JupyterHub
|
||||
|
||||
|
@@ -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
|
||||
|
||||
|
@@ -1,8 +1,8 @@
|
||||
.. _api-index:
|
||||
|
||||
####################
|
||||
The JupyterHub API
|
||||
####################
|
||||
##################
|
||||
The JupyterHub API
|
||||
##################
|
||||
|
||||
:Release: |release|
|
||||
:Date: |today|
|
||||
|
@@ -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
|
||||
|
||||
|
@@ -14,3 +14,4 @@ Module: :mod:`jupyterhub.services.service`
|
||||
|
||||
.. autoconfigurable:: Service
|
||||
:members:
|
||||
|
||||
|
@@ -22,3 +22,4 @@ Module: :mod:`jupyterhub.services.auth`
|
||||
|
||||
.. autoclass:: HubAuthenticated
|
||||
:members:
|
||||
|
||||
|
@@ -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
|
||||
|
||||
|
@@ -1,6 +1,6 @@
|
||||
=============
|
||||
Users
|
||||
=============
|
||||
=====
|
||||
Users
|
||||
=====
|
||||
|
||||
Module: :mod:`jupyterhub.user`
|
||||
==============================
|
||||
@@ -9,10 +9,15 @@ Module: :mod:`jupyterhub.user`
|
||||
|
||||
.. currentmodule:: jupyterhub.user
|
||||
|
||||
:class:`User`
|
||||
:class:`UserDict`
|
||||
-------------
|
||||
|
||||
.. class:: Server
|
||||
.. autoclass:: UserDict
|
||||
:members:
|
||||
|
||||
|
||||
:class:`User`
|
||||
-------------
|
||||
|
||||
.. autoclass:: User
|
||||
:members: escaped_name
|
||||
@@ -29,3 +34,4 @@ Module: :mod:`jupyterhub.user`
|
||||
.. attribute:: spawner
|
||||
|
||||
The user's :class:`~.Spawner` instance.
|
||||
|
||||
|
Reference in New Issue
Block a user