mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-19 16:03:00 +00:00
Update autodoc doc files
This commit is contained in:
@@ -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
|
||||||
|
|
||||||
|
@@ -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
|
||||||
|
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
.. _api-index:
|
.. _api-index:
|
||||||
|
|
||||||
####################
|
##################
|
||||||
The JupyterHub API
|
The JupyterHub API
|
||||||
####################
|
##################
|
||||||
|
|
||||||
:Release: |release|
|
:Release: |release|
|
||||||
:Date: |today|
|
:Date: |today|
|
||||||
|
@@ -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
|
||||||
|
|
||||||
|
@@ -14,3 +14,4 @@ Module: :mod:`jupyterhub.services.service`
|
|||||||
|
|
||||||
.. autoconfigurable:: Service
|
.. autoconfigurable:: Service
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
@@ -22,3 +22,4 @@ Module: :mod:`jupyterhub.services.auth`
|
|||||||
|
|
||||||
.. autoclass:: HubAuthenticated
|
.. autoclass:: HubAuthenticated
|
||||||
:members:
|
:members:
|
||||||
|
|
||||||
|
@@ -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
|
||||||
|
|
||||||
|
@@ -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.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user