Add OpenAPI spec file to docs to show REST API

mahendrapaipuri · mahendrapaipuri · commit cb3fe40561c5 · 2023-04-28T10:29:22.000+02:00
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,5 +2,6 @@ myst-parser
 sphinx-autobuild
 sphinx-book-theme
 sphinx-copybutton
+sphinxcontrib-openapi
 sphinxext-opengraph
 sphinxext-rediraffe
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -0,0 +1,8 @@
+.. _api:
+
+=============
+REST API
+=============
+
+.. openapi:: ../../jupyter_server_proxy/api.yml
+    :examples:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -23,9 +23,10 @@
     "sphinx_copybutton",
     "sphinxext.opengraph",
     "sphinxext.rediraffe",
+    "sphinxcontrib.openapi",
 ]
 root_doc = "index"
-source_suffix = [".md"]
+source_suffix = [".md", ".rst"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -30,6 +30,7 @@ install
 server-process
 launchers
 arbitrary-ports-hosts
+api
 ```
 
 ## Convenience packages for popular applications
