Repository navigation
docs,packaging: fix build warnings and stale docs upload lines - #831
Merged
Merged
Conversation
- 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cleanups from the 4.0.5 release log. Nothing here was blocking.
other/templates/rst/file.j2hardcoded====as the title underline. It's now sized to the plugin name, and the generatedmavsdk/source/plugins/*.rstfiles are updated to match.s3cmd"Nothing to upload" errors:other/tools/upload_docs.shstill uploaded_static/jquery.jsand_static/underscore.js, which current Sphinx no longer generates. Those two lines are removed.MANIFEST.inlistedmavsdk/bin(a directory, so it never matches a file) plus bothmavsdk_serverandmavsdk_server.exe, and each platform only has one of the two. This is now a singleinclude mavsdk/bin/mavsdk_server*.Tested locally:
make -C mavsdk htmlgoes from 36 warnings to 2.mavsdk_serverand a dummymavsdk_server.exeeach include the binary undermavsdk_grpc/bin/, with no manifest warnings.The two remaining Sphinx warnings come from
*10^7in aMissionItemcomment in themission_rawproto. That needs fixing in MAVSDK-Proto.