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.
Fixes #282 (comment)
Adds https://pypi.org/project/sphinx-lint/ and fixes all errors pointed out by it.
Also fixing a broken bullet list I manually noticed
I did not add any of the following linters, but that could be revisited
https://github.com/rstcheck/rstcheck which pointed out the markdown url in
changelog.rst
, but it was otherwise very noisy and didn't point out any actual errors.https://github.com/PyCQA/doc8 complains about a ton of lines being too long, so if we want to stick with a max char line length it's the tool to go for. I personally feel it's got much less of an upside compared to code, and can be a major hassle to reflow lines after editing them instead of just letting autowrap handle it.
https://github.com/twolfson/restructuredtext-lint appears to have very few and very specific rules (that I'm guessing are mostly covered by one or more of the above linters)