diff --git a/build-docs.sh b/build-docs.sh index 1e935bedadb15cea9616cee9e1b5feaf13aa3416..9ac7997e286c2dbd0073f597c323c80de11eb992 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 964489e83af35cf1cd2df09aef3b869417d2f2ec..0000000000000000000000000000000000000000 --- 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 8f99a538954cd6364240e9e6c5a60a212ddd44ed..0000000000000000000000000000000000000000 --- 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 3732b95b005e234b97ace16d5222488bbf7b78a1..9e5c505600059c4517dcb99793126e1558fbac2f 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>`_