Render HTTP API documentation inline

BluEye-Robotics · Sep 25, 2023 · 5d71812 · 5d71812
1 parent e999b63
commit 5d71812
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 4 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -25,8 +25,6 @@ jobs:
           poetry-version: "1.3.2"
       - name: Install dependencies
         run: poetry install
-      - name: Build HTTP documentation
-        run: npx @redocly/cli build-docs http-api.yml --output docs/http-api.html
       - name: Build python reference
         run: |
           poetry run pdocs as_markdown blueye.sdk -o docs/reference

diff --git a/docs/http-api.md b/docs/http-api.md
@@ -0,0 +1,5 @@
+---
+hide:
+  - toc
+---
+<swagger-ui src="http-api.yml"/>
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,6 +5,8 @@ plugins:
   - search
   - macros:
       module_name: doc_utils
+  - swagger-ui-tag:
+      supportedSubmitMethods: []
 
 markdown_extensions:
   - admonition
@@ -55,7 +57,7 @@ nav:
   - "Subscribing to a telemetry message": "telemetry-callback.md"
   - "Updating from v1 to v2": "migrating-to-v2.md"
   - "Protobuf protocol": "protobuf-protocol.md"
-  - "HTTP API": "http-api.html"
+  - "HTTP API": "http-api.md"
   - Reference:
       - blueye.sdk.battery: "reference/blueye/sdk/battery.md"
       - blueye.sdk.camera: "reference/blueye/sdk/camera.md"

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -29,6 +29,7 @@ packaging = "^22.0"
 python-dateutil = "^2.8.2"
 pyzmq = "^25.0.0"
 proto-plus = "^1.22.2"
+mkdocs-swagger-ui-tag = "^0.6.5"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.4"