Fix all sphinx warnings and make CI error when new warnings are introduced #1667
Conversation
This file contains 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
Makes the Global Shortcuts description actually show up in the docs and the website, fixes a few links and manages to reduce the number of warnings being generated when building the docs. Closes: flatpak#1663
It generated an error and is unused. We can just drop it.
Instead of copying it to the final destination. This way, sphinx will make sure we have all the images that we reference, and then copies it to the final destination. The end result is that this removes all the warnings and will warn if we actually are missing something.
Now that we got rid of all the warnings, we can make them into errors and the CI will make sure we're not introducing any new warnings.
|
|
|
Thanks, opened #1668. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
/cc @jimmac, this one needs new icons for... the
Iconspage.