From 40d4f03c560f6a54b55b75f482ffcebb461d7e38 Mon Sep 17 00:00:00 2001
From: Tim Kreuzer <t.kreuzer@fz-juelich.de>
Date: Mon, 22 Apr 2024 22:07:48 +0200
Subject: [PATCH] add docs
---
docs/apiendpoints.md | 2 +-
docs/conf.py | 2 +-
docs/spawners/unicorespawner.md | 2 ++
3 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/docs/apiendpoints.md b/docs/apiendpoints.md
index 68de382..84ae542 100644
--- a/docs/apiendpoints.md
+++ b/docs/apiendpoints.md
@@ -1,6 +1,6 @@
# API Endpoints
-Below is an interactive view of the OutpostSpawner REST API specification.
+Below is an interactive view of the UNICORESpawner REST API specification.
<!-- client-rendered openapi UI copied from FastAPI -->
diff --git a/docs/conf.py b/docs/conf.py
index b65c05e..c32e4d5 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -81,7 +81,7 @@ myst_enable_extensions = [
# a list of builtin themes.
#
html_theme = "sphinx_book_theme"
-html_title = "ForwardBaseSpawner"
+html_title = "UNICORESpawner"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
diff --git a/docs/spawners/unicorespawner.md b/docs/spawners/unicorespawner.md
index e00109b..1a96f8e 100644
--- a/docs/spawners/unicorespawner.md
+++ b/docs/spawners/unicorespawner.md
@@ -1,5 +1,7 @@
# UNICORESpawner
+Also look at the configuration of the base class [JupyterHub ForwardBaseSpawner](https://jupyterhub-forwardbasespawner.readthedocs.io/en/latest/spawners/forwardbasespawner.html)
+
```{eval-rst}
.. automodule:: unicorespawner
```
--
GitLab