From c2bef3c1a6342fc7b33b1febc98799ba7c98d183 Mon Sep 17 00:00:00 2001 From: Julian Oes Date: Wed, 7 Oct 2026 21:41:30 +1300 Subject: [PATCH] docs,packaging: fix build warnings and stale docs upload lines - rst template: size the title underline to the plugin name, and fix the generated plugin pages. Sphinx warned 'Title underline too short' for 34 of them. - upload_docs.sh: drop jquery.js and underscore.js, which current Sphinx no longer generates, so s3cmd failed with 'Nothing to upload'. - MANIFEST.in: use one glob for mavsdk_server(.exe). Each platform only has one of the two, and 'include mavsdk/bin' matched no file, so setuptools warned 'no files found matching' on every build. --- MANIFEST.in | 4 +--- mavsdk/source/plugins/action.rst | 2 +- mavsdk/source/plugins/action_server.rst | 2 +- mavsdk/source/plugins/arm_authorizer_server.rst | 2 +- mavsdk/source/plugins/calibration.rst | 2 +- mavsdk/source/plugins/camera.rst | 2 +- mavsdk/source/plugins/camera_server.rst | 2 +- mavsdk/source/plugins/component_metadata.rst | 2 +- mavsdk/source/plugins/component_metadata_server.rst | 2 +- mavsdk/source/plugins/events.rst | 2 +- mavsdk/source/plugins/failure.rst | 2 +- mavsdk/source/plugins/follow_me.rst | 2 +- mavsdk/source/plugins/ftp.rst | 2 +- mavsdk/source/plugins/ftp_server.rst | 2 +- mavsdk/source/plugins/geofence.rst | 2 +- mavsdk/source/plugins/gimbal.rst | 2 +- mavsdk/source/plugins/gripper.rst | 2 +- mavsdk/source/plugins/log_files.rst | 2 +- mavsdk/source/plugins/log_streaming.rst | 2 +- mavsdk/source/plugins/manual_control.rst | 2 +- mavsdk/source/plugins/mavlink_direct.rst | 2 +- mavsdk/source/plugins/mavlink_direct_server.rst | 2 +- mavsdk/source/plugins/mission.rst | 2 +- mavsdk/source/plugins/mission_raw.rst | 2 +- mavsdk/source/plugins/mission_raw_server.rst | 2 +- mavsdk/source/plugins/mocap.rst | 2 +- mavsdk/source/plugins/offboard.rst | 2 +- mavsdk/source/plugins/param.rst | 2 +- mavsdk/source/plugins/param_server.rst | 2 +- mavsdk/source/plugins/rtk.rst | 2 +- mavsdk/source/plugins/server_utility.rst | 2 +- mavsdk/source/plugins/shell.rst | 2 +- mavsdk/source/plugins/telemetry.rst | 2 +- mavsdk/source/plugins/telemetry_server.rst | 2 +- mavsdk/source/plugins/tracking_server.rst | 2 +- mavsdk/source/plugins/transponder.rst | 2 +- mavsdk/source/plugins/winch.rst | 2 +- other/templates/rst/file.j2 | 2 +- other/tools/upload_docs.sh | 2 -- 39 files changed, 38 insertions(+), 42 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index 6e64f2ba..aff97809 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1 @@ -include mavsdk/bin -include mavsdk/bin/mavsdk_server -include mavsdk/bin/mavsdk_server.exe +include mavsdk/bin/mavsdk_server* diff --git a/mavsdk/source/plugins/action.rst b/mavsdk/source/plugins/action.rst index 1f008172..16e0551e 100644 --- a/mavsdk/source/plugins/action.rst +++ b/mavsdk/source/plugins/action.rst @@ -1,5 +1,5 @@ Action -==== +====== .. automodule:: mavsdk.action :members: diff --git a/mavsdk/source/plugins/action_server.rst b/mavsdk/source/plugins/action_server.rst index 954ea1bd..47236e49 100644 --- a/mavsdk/source/plugins/action_server.rst +++ b/mavsdk/source/plugins/action_server.rst @@ -1,5 +1,5 @@ ActionServer -==== +============ .. automodule:: mavsdk.action_server :members: diff --git a/mavsdk/source/plugins/arm_authorizer_server.rst b/mavsdk/source/plugins/arm_authorizer_server.rst index fdb7ffdc..8d1c735f 100644 --- a/mavsdk/source/plugins/arm_authorizer_server.rst +++ b/mavsdk/source/plugins/arm_authorizer_server.rst @@ -1,5 +1,5 @@ ArmAuthorizerServer -==== +=================== .. automodule:: mavsdk.arm_authorizer_server :members: diff --git a/mavsdk/source/plugins/calibration.rst b/mavsdk/source/plugins/calibration.rst index 39ca428d..dac0a794 100644 --- a/mavsdk/source/plugins/calibration.rst +++ b/mavsdk/source/plugins/calibration.rst @@ -1,5 +1,5 @@ Calibration -==== +=========== .. automodule:: mavsdk.calibration :members: diff --git a/mavsdk/source/plugins/camera.rst b/mavsdk/source/plugins/camera.rst index 2b75b5f1..7fa72555 100644 --- a/mavsdk/source/plugins/camera.rst +++ b/mavsdk/source/plugins/camera.rst @@ -1,5 +1,5 @@ Camera -==== +====== .. automodule:: mavsdk.camera :members: diff --git a/mavsdk/source/plugins/camera_server.rst b/mavsdk/source/plugins/camera_server.rst index f65c96e6..e98e615b 100644 --- a/mavsdk/source/plugins/camera_server.rst +++ b/mavsdk/source/plugins/camera_server.rst @@ -1,5 +1,5 @@ CameraServer -==== +============ .. automodule:: mavsdk.camera_server :members: diff --git a/mavsdk/source/plugins/component_metadata.rst b/mavsdk/source/plugins/component_metadata.rst index 12fef09e..f58e2815 100644 --- a/mavsdk/source/plugins/component_metadata.rst +++ b/mavsdk/source/plugins/component_metadata.rst @@ -1,5 +1,5 @@ ComponentMetadata -==== +================= .. automodule:: mavsdk.component_metadata :members: diff --git a/mavsdk/source/plugins/component_metadata_server.rst b/mavsdk/source/plugins/component_metadata_server.rst index e2139ef1..5b5acc53 100644 --- a/mavsdk/source/plugins/component_metadata_server.rst +++ b/mavsdk/source/plugins/component_metadata_server.rst @@ -1,5 +1,5 @@ ComponentMetadataServer -==== +======================= .. automodule:: mavsdk.component_metadata_server :members: diff --git a/mavsdk/source/plugins/events.rst b/mavsdk/source/plugins/events.rst index be1ef627..a379bf00 100644 --- a/mavsdk/source/plugins/events.rst +++ b/mavsdk/source/plugins/events.rst @@ -1,5 +1,5 @@ Events -==== +====== .. automodule:: mavsdk.events :members: diff --git a/mavsdk/source/plugins/failure.rst b/mavsdk/source/plugins/failure.rst index c72ed4c2..ba48a8f7 100644 --- a/mavsdk/source/plugins/failure.rst +++ b/mavsdk/source/plugins/failure.rst @@ -1,5 +1,5 @@ Failure -==== +======= .. automodule:: mavsdk.failure :members: diff --git a/mavsdk/source/plugins/follow_me.rst b/mavsdk/source/plugins/follow_me.rst index 8cd65362..eecfa0cc 100644 --- a/mavsdk/source/plugins/follow_me.rst +++ b/mavsdk/source/plugins/follow_me.rst @@ -1,5 +1,5 @@ FollowMe -==== +======== .. automodule:: mavsdk.follow_me :members: diff --git a/mavsdk/source/plugins/ftp.rst b/mavsdk/source/plugins/ftp.rst index c07469fa..b34a444c 100644 --- a/mavsdk/source/plugins/ftp.rst +++ b/mavsdk/source/plugins/ftp.rst @@ -1,5 +1,5 @@ Ftp -==== +=== .. automodule:: mavsdk.ftp :members: diff --git a/mavsdk/source/plugins/ftp_server.rst b/mavsdk/source/plugins/ftp_server.rst index f7ee2923..0b8bfb21 100644 --- a/mavsdk/source/plugins/ftp_server.rst +++ b/mavsdk/source/plugins/ftp_server.rst @@ -1,5 +1,5 @@ FtpServer -==== +========= .. automodule:: mavsdk.ftp_server :members: diff --git a/mavsdk/source/plugins/geofence.rst b/mavsdk/source/plugins/geofence.rst index 533cb0b5..dd9b86b9 100644 --- a/mavsdk/source/plugins/geofence.rst +++ b/mavsdk/source/plugins/geofence.rst @@ -1,5 +1,5 @@ Geofence -==== +======== .. automodule:: mavsdk.geofence :members: diff --git a/mavsdk/source/plugins/gimbal.rst b/mavsdk/source/plugins/gimbal.rst index dfef4251..b59619eb 100644 --- a/mavsdk/source/plugins/gimbal.rst +++ b/mavsdk/source/plugins/gimbal.rst @@ -1,5 +1,5 @@ Gimbal -==== +====== .. automodule:: mavsdk.gimbal :members: diff --git a/mavsdk/source/plugins/gripper.rst b/mavsdk/source/plugins/gripper.rst index 2d2fd111..45e8cd00 100644 --- a/mavsdk/source/plugins/gripper.rst +++ b/mavsdk/source/plugins/gripper.rst @@ -1,5 +1,5 @@ Gripper -==== +======= .. automodule:: mavsdk.gripper :members: diff --git a/mavsdk/source/plugins/log_files.rst b/mavsdk/source/plugins/log_files.rst index e394ec2a..8e2b613f 100644 --- a/mavsdk/source/plugins/log_files.rst +++ b/mavsdk/source/plugins/log_files.rst @@ -1,5 +1,5 @@ LogFiles -==== +======== .. automodule:: mavsdk.log_files :members: diff --git a/mavsdk/source/plugins/log_streaming.rst b/mavsdk/source/plugins/log_streaming.rst index a76b927c..acfb8823 100644 --- a/mavsdk/source/plugins/log_streaming.rst +++ b/mavsdk/source/plugins/log_streaming.rst @@ -1,5 +1,5 @@ LogStreaming -==== +============ .. automodule:: mavsdk.log_streaming :members: diff --git a/mavsdk/source/plugins/manual_control.rst b/mavsdk/source/plugins/manual_control.rst index bf3f498b..2de5c39d 100644 --- a/mavsdk/source/plugins/manual_control.rst +++ b/mavsdk/source/plugins/manual_control.rst @@ -1,5 +1,5 @@ ManualControl -==== +============= .. automodule:: mavsdk.manual_control :members: diff --git a/mavsdk/source/plugins/mavlink_direct.rst b/mavsdk/source/plugins/mavlink_direct.rst index 44619f83..b480030b 100644 --- a/mavsdk/source/plugins/mavlink_direct.rst +++ b/mavsdk/source/plugins/mavlink_direct.rst @@ -1,5 +1,5 @@ MavlinkDirect -==== +============= .. automodule:: mavsdk.mavlink_direct :members: diff --git a/mavsdk/source/plugins/mavlink_direct_server.rst b/mavsdk/source/plugins/mavlink_direct_server.rst index 53ae43b7..f62ca0dd 100644 --- a/mavsdk/source/plugins/mavlink_direct_server.rst +++ b/mavsdk/source/plugins/mavlink_direct_server.rst @@ -1,5 +1,5 @@ MavlinkDirectServer -==== +=================== .. automodule:: mavsdk.mavlink_direct_server :members: diff --git a/mavsdk/source/plugins/mission.rst b/mavsdk/source/plugins/mission.rst index 9bd74f35..e8bb9f02 100644 --- a/mavsdk/source/plugins/mission.rst +++ b/mavsdk/source/plugins/mission.rst @@ -1,5 +1,5 @@ Mission -==== +======= .. automodule:: mavsdk.mission :members: diff --git a/mavsdk/source/plugins/mission_raw.rst b/mavsdk/source/plugins/mission_raw.rst index 20aa6e4e..e02bdb82 100644 --- a/mavsdk/source/plugins/mission_raw.rst +++ b/mavsdk/source/plugins/mission_raw.rst @@ -1,5 +1,5 @@ MissionRaw -==== +========== .. automodule:: mavsdk.mission_raw :members: diff --git a/mavsdk/source/plugins/mission_raw_server.rst b/mavsdk/source/plugins/mission_raw_server.rst index b627938b..18b5d0c1 100644 --- a/mavsdk/source/plugins/mission_raw_server.rst +++ b/mavsdk/source/plugins/mission_raw_server.rst @@ -1,5 +1,5 @@ MissionRawServer -==== +================ .. automodule:: mavsdk.mission_raw_server :members: diff --git a/mavsdk/source/plugins/mocap.rst b/mavsdk/source/plugins/mocap.rst index b7d36ad5..de33cc80 100644 --- a/mavsdk/source/plugins/mocap.rst +++ b/mavsdk/source/plugins/mocap.rst @@ -1,5 +1,5 @@ Mocap -==== +===== .. automodule:: mavsdk.mocap :members: diff --git a/mavsdk/source/plugins/offboard.rst b/mavsdk/source/plugins/offboard.rst index 412c3258..b919c169 100644 --- a/mavsdk/source/plugins/offboard.rst +++ b/mavsdk/source/plugins/offboard.rst @@ -1,5 +1,5 @@ Offboard -==== +======== .. automodule:: mavsdk.offboard :members: diff --git a/mavsdk/source/plugins/param.rst b/mavsdk/source/plugins/param.rst index c301b85e..26d7cde4 100644 --- a/mavsdk/source/plugins/param.rst +++ b/mavsdk/source/plugins/param.rst @@ -1,5 +1,5 @@ Param -==== +===== .. automodule:: mavsdk.param :members: diff --git a/mavsdk/source/plugins/param_server.rst b/mavsdk/source/plugins/param_server.rst index b4bd092c..7f2e9e63 100644 --- a/mavsdk/source/plugins/param_server.rst +++ b/mavsdk/source/plugins/param_server.rst @@ -1,5 +1,5 @@ ParamServer -==== +=========== .. automodule:: mavsdk.param_server :members: diff --git a/mavsdk/source/plugins/rtk.rst b/mavsdk/source/plugins/rtk.rst index ca0a94de..8ef473ac 100644 --- a/mavsdk/source/plugins/rtk.rst +++ b/mavsdk/source/plugins/rtk.rst @@ -1,5 +1,5 @@ Rtk -==== +=== .. automodule:: mavsdk.rtk :members: diff --git a/mavsdk/source/plugins/server_utility.rst b/mavsdk/source/plugins/server_utility.rst index 4e8202ef..8e5891ac 100644 --- a/mavsdk/source/plugins/server_utility.rst +++ b/mavsdk/source/plugins/server_utility.rst @@ -1,5 +1,5 @@ ServerUtility -==== +============= .. automodule:: mavsdk.server_utility :members: diff --git a/mavsdk/source/plugins/shell.rst b/mavsdk/source/plugins/shell.rst index 29d28900..7ecaee67 100644 --- a/mavsdk/source/plugins/shell.rst +++ b/mavsdk/source/plugins/shell.rst @@ -1,5 +1,5 @@ Shell -==== +===== .. automodule:: mavsdk.shell :members: diff --git a/mavsdk/source/plugins/telemetry.rst b/mavsdk/source/plugins/telemetry.rst index 5b44d56d..c3bbe374 100644 --- a/mavsdk/source/plugins/telemetry.rst +++ b/mavsdk/source/plugins/telemetry.rst @@ -1,5 +1,5 @@ Telemetry -==== +========= .. automodule:: mavsdk.telemetry :members: diff --git a/mavsdk/source/plugins/telemetry_server.rst b/mavsdk/source/plugins/telemetry_server.rst index cafdf453..fbc923b0 100644 --- a/mavsdk/source/plugins/telemetry_server.rst +++ b/mavsdk/source/plugins/telemetry_server.rst @@ -1,5 +1,5 @@ TelemetryServer -==== +=============== .. automodule:: mavsdk.telemetry_server :members: diff --git a/mavsdk/source/plugins/tracking_server.rst b/mavsdk/source/plugins/tracking_server.rst index e176f7f6..1b2a27f5 100644 --- a/mavsdk/source/plugins/tracking_server.rst +++ b/mavsdk/source/plugins/tracking_server.rst @@ -1,5 +1,5 @@ TrackingServer -==== +============== .. automodule:: mavsdk.tracking_server :members: diff --git a/mavsdk/source/plugins/transponder.rst b/mavsdk/source/plugins/transponder.rst index e4a2e65c..ab5f5fa1 100644 --- a/mavsdk/source/plugins/transponder.rst +++ b/mavsdk/source/plugins/transponder.rst @@ -1,5 +1,5 @@ Transponder -==== +=========== .. automodule:: mavsdk.transponder :members: diff --git a/mavsdk/source/plugins/winch.rst b/mavsdk/source/plugins/winch.rst index d61ed448..1e9c2e04 100644 --- a/mavsdk/source/plugins/winch.rst +++ b/mavsdk/source/plugins/winch.rst @@ -1,5 +1,5 @@ Winch -==== +===== .. automodule:: mavsdk.winch :members: diff --git a/other/templates/rst/file.j2 b/other/templates/rst/file.j2 index 09de634e..f40b8257 100644 --- a/other/templates/rst/file.j2 +++ b/other/templates/rst/file.j2 @@ -1,5 +1,5 @@ {{ plugin_name.upper_camel_case }} -==== +{{ "=" * (plugin_name.upper_camel_case | length) }} .. automodule:: mavsdk.{{ plugin_name.lower_snake_case }} :members: diff --git a/other/tools/upload_docs.sh b/other/tools/upload_docs.sh index 15c44638..4def9fd0 100755 --- a/other/tools/upload_docs.sh +++ b/other/tools/upload_docs.sh @@ -10,9 +10,7 @@ s3cmd sync mavsdk/build/html/ s3://mavsdk-python-docs s3cmd put -m text/html mavsdk/build/html/index.html s3://mavsdk-python-docs s3cmd put -m text/javascript mavsdk/build/html/searchindex.js s3://mavsdk-python-docs -s3cmd put -m text/javascript mavsdk/build/html/_static/jquery.js s3://mavsdk-python-docs/_static/ s3cmd put -m text/javascript mavsdk/build/html/_static/doctools.js s3://mavsdk-python-docs/_static/ -s3cmd put -m text/javascript mavsdk/build/html/_static/underscore.js s3://mavsdk-python-docs/_static/ s3cmd put -m text/javascript mavsdk/build/html/_static/documentation_options.js s3://mavsdk-python-docs/_static/ s3cmd put -m text/javascript mavsdk/build/html/_static/language_data.js s3://mavsdk-python-docs/_static/ s3cmd put -m text/css mavsdk/build/html/_static/nature.css s3://mavsdk-python-docs/_static/