mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-07 18:14:10 +00:00

While doing https://github.com/jupyterhub/jupyterhub/pull/2726, I realized we don't have a consistent way to format references inside the docs. I now have them be formatted to match the name of the file, but using `:` to separate them instead of `/` or `-`. `/` makes it ambiguous when using with markdown link syntax, as it could be a reference or a file. And using `-` is ambiguous, as that can be the name of the file itself. This PR does about half, I can do the other half later (unless someone else does).
751 B
751 B
(api-index)=
JupyterHub API Reference
: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 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
:maxdepth: 1
../rest-api
app
auth
spawner
proxy
user
service
services.auth