Fix all sphinx warnings #1796
Merged
Fix all sphinx warnings #1796
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
3 tasks
mattwthompson
approved these changes
Dec 20, 2023
There was a problem hiding this comment.
I read or skimmed ever file in the changeset, making an effort to sample some links and actually look at rendered webpages along the way. I found only one thing that stands out as needing fixing - no need for a re-review!
The end of the release history page looks funky:
Comment on lines
414
to
416
| +-----------------------+------------+-----------+-------------+------------+-----------+-------------+ | ||
| | Python 3.12 and newer | Pending official releases and upstream support | | ||
| +-----------------------+------------+-----------+-------------+------------+-----------+-------------+ |
There was a problem hiding this comment.
You are welcome to update this table so that 3.12 looks like 3.11 and this line applies to 3.13+, but that's not needed to get this merged
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.
This PR fixes all existing Sphinx warnings, in part by updating to Sphinx 6. It also sets RTD to fail a docs build on a warning. I'm hoping this will stop a recurring issue where incorrect ReStructuredText gets into releases without anyone noticing (because ReST is impossible to write correctly without a detailed dialogue between the parser and whitespace)
One thing this needed is to convert the remaining RST in the changelog to MarkDown. This uncovered a bunch of broken links and also renders better as there no longer needs to be a distinction between old releases and new releases.