write schema to sphinx to make it usable in editors

Author: mathiasertl

.readthedocs.yaml

@@ -24,7 +24,7 @@ build:
       - uv sync --group dev --group rtd
     pre_build:
       - ./fetch_swagger.sh
-      - uv run generate-schema.py
+      - uv run generate-schema.py -o > docs/_static/schema.json
     build:
       html:
         - uv run sphinx-build -T -b html docs/ $READTHEDOCS_OUTPUT/html

generate-schema.py

@@ -67,4 +67,7 @@ def generate_openapi_schema(
     fh.write(swagger_js)
 
 if args.output:
-    print(json.dumps(openapi, indent=4, sort_keys=True))
+    schema = TutorialModel.model_json_schema()
+    del schema["properties"]["path"]
+    schema["required"].remove("path")
+    print(json.dumps(schema, indent=4, sort_keys=True))