BluEye-Robotics / blueye.sdk

A Python package for remote control of Blueye underwater drones.
GNU Lesser General Public License v3.0
17 stars 4 forks source link

Render HTTP docs in page #152

Open sindrehan opened 1 year ago

sindrehan commented 1 year ago

This way inline instead of this way redoc

Some considerations:

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (bc26855) 73.17% compared to head (ef54904) 73.17%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #152 +/- ## ======================================= Coverage 73.17% 73.17% ======================================= Files 11 11 Lines 1178 1178 ======================================= Hits 862 862 Misses 316 316 ``` | [Flag](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | Coverage Δ | | |---|---|---| | [macos-latest_3.10](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.17% <ø> (ø)` | | | [macos-latest_3.11](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.17% <ø> (ø)` | | | [macos-latest_3.8](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.15% <ø> (ø)` | | | [macos-latest_3.9](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.15% <ø> (ø)` | | | [ubuntu-latest_3.10](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.17% <ø> (ø)` | | | [ubuntu-latest_3.11](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.17% <ø> (ø)` | | | [ubuntu-latest_3.8](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.15% <ø> (ø)` | | | [ubuntu-latest_3.9](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.15% <ø> (ø)` | | | [windows-latest_3.10](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.15% <ø> (ø)` | | | [windows-latest_3.11](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.15% <ø> (?)` | | | [windows-latest_3.8](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.12% <ø> (ø)` | | | [windows-latest_3.9](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/152/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `73.12% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

sindrehan commented 1 year ago

Figured out how to use the render_swagger plugin to show the output from redoc redoc-light Doesn't work very well with dark mode though redoc-dark

Pretty sure that's fixable with some css/js magic.

Here's an example of a dark mode for redoc, redark