mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-16 22:43:00 +00:00
Added redirect and modified api reference section
This commit is contained in:
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