Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render HTTP docs in page #152

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Render HTTP docs in page #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10b0a44
Move OpenAPI specification to docs
sindrehan Sep 25, 2023
c34a0be
Render HTTP API documentation inline
sindrehan Sep 25, 2023
ef54904
Use full width for iframe tag
sindrehan Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 21 additions & 0 deletions docs/http-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
hide:
- toc
---
<style>
@media only screen and (min-width: 76.25em) {
.md-main__inner {
max-width: none;
}
.md-sidebar--primary {
left: 0;
}
.md-sidebar--secondary {
right: 0;
margin-left: 0;
-webkit-transform: none;
transform: none;
}
}
</style>
<swagger-ui src="http-api.yml"/>
0 http-api.yml → docs/http-api.yml
View file
Open in desktop
File renamed without changes.
4 changes: 3 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ plugins:
- search
- macros:
module_name: doc_utils
- swagger-ui-tag:
supportedSubmitMethods: []

markdown_extensions:
- admonition
Expand Down Expand Up @@ -69,7 +71,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"
Expand Down
45 changes: 44 additions & 1 deletion poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down