From 7ddd3b058902bcc946ce0672b6eaa1d50fcfb9b0 Mon Sep 17 00:00:00 2001 From: Simon Li Date: Thu, 18 May 2023 16:23:21 +0100 Subject: [PATCH] Config reference: link to nicer(?) API docs first `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. --- docs/source/reference/config-reference.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/reference/config-reference.md b/docs/source/reference/config-reference.md index 33e5e9ff..45021cf6 100644 --- a/docs/source/reference/config-reference.md +++ b/docs/source/reference/config-reference.md @@ -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}