Skip to content

Commit

Permalink
Config reference: link to nicer(?) API docs first
Browse files Browse the repository at this point in the history
`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.
  • Loading branch information
manics committed May 18, 2023
1 parent 9ea9902 commit 7ddd3b0
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/reference/config-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ section, the `jupyterhub_config.py` can be automatically generated via
> 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.
```{eval-rst}
Expand Down

0 comments on commit 7ddd3b0

Please sign in to comment.