Fix Sphinx warnings #6239
Merged
Fix Sphinx warnings #6239
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
tjhei
approved these changes
Feb 20, 2025
|
@gassmoeller It looks like the github markdown renderer does not like the links written this way. :-( |
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.
It looks like readthedocs has upgraded its Sphinx version, which now produces new warnings in our documentation (e.g. in #6235 here). As far as I can tell this is caused by internal links that specify markdown files with their file ending. The links work with or without file ending, but with the ending there is a warning in the build process (which is interpreted as an error by our CI because of our configuration). Removing the file ending removes the warning and the links still work (checked in both html and pdf).