doc: extend linters, manage deps via bazel #4503
Merged
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
|
This change is |
jiceatscion
approved these changes
Apr 11, 2024
There was a problem hiding this comment.
Works for me.
Reviewed 38 of 40 files at r1, 1 of 1 files at r2, 2 of 2 files at r3, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @matzf)
oncilla
approved these changes
Apr 19, 2024
There was a problem hiding this comment.
Reviewed 38 of 40 files at r1, 1 of 1 files at r2, 2 of 2 files at r3, all commit messages.
Reviewable status:
oncilla
approved these changes
Apr 19, 2024
There was a problem hiding this comment.
Reviewable status:
Use Node.js-based github.com/DavidAnson/markdownlint-cli2, replacing the ruby-based github.com/markdownlint/markdownlint. This tool has a cleaner configuration file and that is well supported in vs code and other editors. Adapted from scionproto#4328. Co-authored-by: Dominik Roos <roos@anapaya.net>
of course that was totally on purpose, just testing...
This was referenced Jul 9, 2024
Closed
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.
use markdownlint-cli2 instead of ruby markdownlint
Use Node.js-based github.com/DavidAnson/markdownlint-cli2, replacing the ruby-based github.com/markdownlint/markdownlint. This tool has a cleaner configuration file and that is well supported in vs code and other editors.
Adapted from tools: add editor and lint configuration #4328.
add sphinx-lint, and manage the doc requirements via bazel/rules_python.
Fix a large number of legitimage linter warnings; most cases were accidentally applying the "default role" (single backticks instead of double-backticks), or the occasional missing underscore after external links.
add bazel run targets to run sphinx-build and sphinx-autobuild via python deps managed by bazel. This makes it easy to locally build the documentation for devs that already have bazel set up (while hopefully keeping things still relatively straight-forward).