[x] Based your PR on the latest version of the correct branch (master or 4.x)
[x] Checked your writing carefully for correct English spelling, grammar, etc
[x] Described your changes and the motivation for them below
Description of Changes
Presently, both the docs linkcheck and the pre-commit checks are failing on master. This PR fixes them. Specifically, it:
[x] Disables codespell, flake8 and pylint for the workshop subdirectory when running under pre-commit, as apparently at least some of the many errors are intentional
[x] Disables pretty-format-yaml on the YAML files in the workshop subdirectory, as they are programmatically generated
[x] Fixes ambiguous duplicate implicit and explicit references identified by rstcheck, and opportunistically single-sources them per style guide
[x] Removes spurious trailing whitespace on the workshop files
[x] Ignores false positives on GitHub diff links causing linkcheck to fail
I plan to reach out to @Linus-Albertus to go through the many spelling and Python errors on those files to determine which are intentional, and resolve the rest.
After we merge this PR, I'll follow it up with another against 4.x that addresses some additional, less critical issues/updates/simplifications in both branches pre-commit and linkcheck workflows.
CAM-Gerlach
commented
2 years ago
Pull Request
Pull Request Checklist
Description of Changes
Presently, both the docs linkcheck and the pre-commit checks are failing on
master. This PR fixes them. Specifically, it:pre-commit, as apparently at least some of the many errors are intentionalI plan to reach out to @Linus-Albertus to go through the many spelling and Python errors on those files to determine which are intentional, and resolve the rest.
After we merge this PR, I'll follow it up with another against
4.xthat addresses some additional, less critical issues/updates/simplifications in both branches pre-commit and linkcheck workflows.