From 84533602415fc87006a46d60f8db5d64428f58b3 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Thu, 25 Jan 2024 13:45:15 +0100
Subject: [PATCH] remove openapi spec from docs as we only have a single
endpoint
---
build-docs.sh | 6 +-----
docs/dump-openapi-spec.py | 20 --------------------
docs/source/_static/openapi.html | 25 -------------------------
docs/source/index.rst | 3 ---
4 files changed, 1 insertion(+), 53 deletions(-)
delete mode 100644 docs/dump-openapi-spec.py
delete mode 100644 docs/source/_static/openapi.html
diff --git a/build-docs.sh b/build-docs.sh
index 1e935be..9ac7997 100755
--- a/build-docs.sh
+++ b/build-docs.sh
@@ -5,12 +5,8 @@ set -o nounset
pip install -r requirements.txt
pip install -e .
-export SETTINGS_FILENAME=./config.json.example
-python docs/dump-openapi-spec.py
-
rm -r ./docs/build/*
vale --config=docs/vale/.vale.ini sync
vale --config=docs/vale/.vale.ini docs/source/*.rst lso/*.py
-sphinx-build -b html docs/source docs/build
-unset SETTINGS_FILENAME
+sphinx-build -b html docs/source docs/build
diff --git a/docs/dump-openapi-spec.py b/docs/dump-openapi-spec.py
deleted file mode 100644
index 964489e..0000000
--- a/docs/dump-openapi-spec.py
+++ /dev/null
@@ -1,20 +0,0 @@
-import json
-import os
-
-from fastapi.testclient import TestClient
-import lso
-
-config_filename = os.path.join(os.path.dirname(__file__), "..", "config.json.example")
-
-output_filename = os.path.join(os.path.dirname(__file__), "source", "_static", "openapi.json")
-
-os.environ["SETTINGS_FILENAME"] = config_filename
-app = lso.create_app()
-client = TestClient(app)
-rsp = client.get("/openapi.json")
-openapi_doc = json.dumps(rsp.json(), indent=2)
-
-with open(output_filename, "w") as f:
- f.write(openapi_doc)
-
-print(f"wrote {output_filename}")
diff --git a/docs/source/_static/openapi.html b/docs/source/_static/openapi.html
deleted file mode 100644
index 8f99a53..0000000
--- a/docs/source/_static/openapi.html
+++ /dev/null
@@ -1,25 +0,0 @@
-<html lang="en">
-<head>
- <meta charset="utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1" />
- <meta
- name="description"
- content="SwaggerUI"
- />
- <title>SwaggerUI</title>
- <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui.css" />
-</head>
-<body>
-<div id="swagger-ui"></div>
-<script src="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui-bundle.js" crossorigin></script>
-<script>
- window.onload = () => {
- window.ui = SwaggerUIBundle({
- url: 'openapi.json',
- dom_id: '#swagger-ui',
- });
- };
-</script>
-</body>
-</html>
-
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3732b95..9e5c505 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -9,6 +9,3 @@ Documentation for LSO (Lightweight Service Orchestrator).
quickstart
modules
-
-
-`Swagger API Docs <_static/openapi.html>`_
--
GitLab