mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-08 10:34:10 +00:00
Added redirect and modified api reference section
This commit is contained in:
13
docs/source/reference/api/app.md
Normal file
13
docs/source/reference/api/app.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Application configuration
|
||||
|
||||
## Module: {mod}`jupyterhub.app`
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: jupyterhub.app
|
||||
```
|
||||
|
||||
### {class}`JupyterHub`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: JupyterHub
|
||||
```
|
33
docs/source/reference/api/auth.md
Normal file
33
docs/source/reference/api/auth.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Authenticators
|
||||
|
||||
## Module: {mod}`jupyterhub.auth`
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: jupyterhub.auth
|
||||
```
|
||||
|
||||
### {class}`Authenticator`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: Authenticator
|
||||
:members:
|
||||
```
|
||||
|
||||
### {class}`LocalAuthenticator`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: LocalAuthenticator
|
||||
:members:
|
||||
```
|
||||
|
||||
### {class}`PAMAuthenticator`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: PAMAuthenticator
|
||||
```
|
||||
|
||||
### {class}`DummyAuthenticator`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: DummyAuthenticator
|
||||
```
|
36
docs/source/reference/api/index.md
Normal file
36
docs/source/reference/api/index.md
Normal file
@@ -0,0 +1,36 @@
|
||||
(api-index)=
|
||||
|
||||
# JupyterHub API Reference
|
||||
|
||||
<!--
|
||||
Below is a MyST field list, using MyST substitution, as supported
|
||||
by enabling the respective MyST extensions in docs/source/conf.py.
|
||||
-->
|
||||
|
||||
:Date: {{ date }}
|
||||
:Release: {{ version }}
|
||||
|
||||
JupyterHub also provides a REST API for administration of the Hub and users.
|
||||
The documentation on [Using JupyterHub's REST API](using-jupyterhub-rest-api) provides
|
||||
information on:
|
||||
|
||||
- what you can do with the API
|
||||
- creating an API token
|
||||
- adding API tokens to the config files
|
||||
- making an API request programmatically using the requests library
|
||||
- learning more about JupyterHub's API
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
|
||||
../rest-api
|
||||
app
|
||||
auth
|
||||
spawner
|
||||
proxy
|
||||
user
|
||||
service
|
||||
services.auth
|
||||
```
|
||||
|
||||
[openapi initiative]: https://www.openapis.org/
|
21
docs/source/reference/api/proxy.md
Normal file
21
docs/source/reference/api/proxy.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Proxies
|
||||
|
||||
## Module: {mod}`jupyterhub.proxy`
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: jupyterhub.proxy
|
||||
```
|
||||
|
||||
### {class}`Proxy`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: Proxy
|
||||
:members:
|
||||
```
|
||||
|
||||
### {class}`ConfigurableHTTPProxy`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: ConfigurableHTTPProxy
|
||||
:members: debug, auth_token, check_running_interval, api_url, command
|
||||
```
|
14
docs/source/reference/api/service.md
Normal file
14
docs/source/reference/api/service.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Services
|
||||
|
||||
## Module: {mod}`jupyterhub.services.service`
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: jupyterhub.services.service
|
||||
```
|
||||
|
||||
### {class}`Service`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: Service
|
||||
:members: name, admin, url, api_token, managed, kind, command, cwd, environment, user, oauth_client_id, server, prefix, proxy_spec
|
||||
```
|
40
docs/source/reference/api/services.auth.md
Normal file
40
docs/source/reference/api/services.auth.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Services Authentication
|
||||
|
||||
## Module: {mod}`jupyterhub.services.auth`
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: jupyterhub.services.auth
|
||||
```
|
||||
|
||||
### {class}`HubAuth`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: HubAuth
|
||||
:members:
|
||||
```
|
||||
|
||||
### {class}`HubOAuth`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: HubOAuth
|
||||
:members:
|
||||
```
|
||||
|
||||
### {class}`HubAuthenticated`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: HubAuthenticated
|
||||
:members:
|
||||
```
|
||||
|
||||
### {class}`HubOAuthenticated`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: HubOAuthenticated
|
||||
```
|
||||
|
||||
### {class}`HubOAuthCallbackHandler`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: HubOAuthCallbackHandler
|
||||
```
|
20
docs/source/reference/api/spawner.md
Normal file
20
docs/source/reference/api/spawner.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Spawners
|
||||
|
||||
## Module: {mod}`jupyterhub.spawner`
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: jupyterhub.spawner
|
||||
```
|
||||
|
||||
### {class}`Spawner`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: Spawner
|
||||
:members: options_from_form, poll, start, stop, get_args, get_env, get_state, template_namespace, format_string, create_certs, move_certs
|
||||
```
|
||||
|
||||
### {class}`LocalProcessSpawner`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoconfigurable:: LocalProcessSpawner
|
||||
```
|
34
docs/source/reference/api/user.md
Normal file
34
docs/source/reference/api/user.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Users
|
||||
|
||||
## Module: {mod}`jupyterhub.user`
|
||||
|
||||
```{eval-rst}
|
||||
.. automodule:: jupyterhub.user
|
||||
```
|
||||
|
||||
### {class}`UserDict`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: UserDict
|
||||
:members:
|
||||
```
|
||||
|
||||
### {class}`User`
|
||||
|
||||
```{eval-rst}
|
||||
.. autoclass:: User
|
||||
:members: escaped_name
|
||||
|
||||
.. attribute:: name
|
||||
|
||||
The user's name
|
||||
|
||||
.. attribute:: server
|
||||
|
||||
The user's Server data object if running, None otherwise.
|
||||
Has ``ip``, ``port`` attributes.
|
||||
|
||||
.. attribute:: spawner
|
||||
|
||||
The user's :class:`~.Spawner` instance.
|
||||
```
|
Reference in New Issue
Block a user