Add twine check and add README_PYTHON.rst to doc8 linting #1625
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.
Description
Resolves #1582.
twine check
task, which validates the source distribution and raises an error if there are problems in the long description that will prevent proper rendering on PyPI. (See twine check example output from an intentionally failed run.)check-history-rst-syntax
so that it also lints README_PYTHON.rst. Whiletwine check
seems to bail after the first syntax error it encounters, doc8 reports all issues, which would be helpful in the (albeit unlikely) scenario in which README_PYTHON.rst is updated and ends up with multiple syntax issues. (See doc8 example output from an intentionally failed run.)I realize there's a lot of overlap between these two tasks, so I'm open to other options if folks think it's not worthwhile to include both.
Checklist
- [ ] Updated HISTORY.rst and link to any relevant issue (if these changes are user-facing)- [ ] Updated the user's guide (if needed)- [ ] Tested the Workbench UI (if relevant)