hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-18 15:33:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Config reference: link to nicer(?) API docs first

Browse Source 
`Configuration Reference` sounds like it's the place to go to see the full list of JupyterHub config options.
However it's not very readable as it's a plain-text dump of the output of `jupyterhub --generate-config`.

This links to some of the API doc pages instead, which present most of the information in an easier to read format. Unfortunately it also includes a lot of non-traitlets documentation.
This commit is contained in:
Simon Li
2023-05-18 16:23:21 +01:00
parent 9ea9902c76
commit 7ddd3b0589
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/reference/config-reference.md
View File

@@ -14,6 +14,12 @@ section, the `jupyterhub_config.py` can be automatically generated via
> jupyterhub --generate-config > jupyterhub --generate-config
> ``` > ```
Most of this information is available in a nicer format in:
- [](./api/app.md)
- [](./api/auth.md)
- [](./api/spawner.md)
The following contains the output of that command for reference. The following contains the output of that command for reference.
```{eval-rst} ```{eval-rst}