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

Support multiple versions of documentation #150

Closed sindrehan closed 1 year ago

sindrehan commented 1 year ago

This PR removes portray and uses pdocs and mkdocs directly. This allows us to more easily take advantage of the various mkdocs plugins, without being limited by portray mapping mkdocs.yml to pyproject.toml.

It also utilizes mike to implement a drop-down for multiple documentation versions.

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (72acc5a) 72.53% compared to head (83bc7e7) 72.53%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #150 +/- ## ======================================= Coverage 72.53% 72.53% ======================================= Files 11 11 Lines 1158 1158 ======================================= Hits 840 840 Misses 318 318 ``` | [Flag](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/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/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.53% <ø> (ø)` | | | [macos-latest_3.11](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.53% <ø> (ø)` | | | [macos-latest_3.8](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.51% <ø> (ø)` | | | [macos-latest_3.9](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.51% <ø> (ø)` | | | [ubuntu-latest_3.10](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.53% <ø> (ø)` | | | [ubuntu-latest_3.11](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.53% <ø> (ø)` | | | [ubuntu-latest_3.8](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.51% <ø> (ø)` | | | [ubuntu-latest_3.9](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.51% <ø> (ø)` | | | [windows-latest_3.10](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.51% <ø> (ø)` | | | [windows-latest_3.11](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.51% <ø> (ø)` | | | [windows-latest_3.8](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.49% <ø> (ø)` | | | [windows-latest_3.9](https://app.codecov.io/gh/BluEye-Robotics/blueye.sdk/pull/150/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BluEye-Robotics) | `72.49% <ø> (ø)` | | 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.