Optimize documentation linting strategy.#2713
Open
freakboy3742 wants to merge 4 commits intobeeware:mainfrom
Open
Optimize documentation linting strategy.#2713freakboy3742 wants to merge 4 commits intobeeware:mainfrom
freakboy3742 wants to merge 4 commits intobeeware:mainfrom
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Optimize the documentation linting strategy used by docs.
Instead of linting as part of RTD configuration, we lint as part of CI. This means future rebuilds of documentation don't re-validate links - which might have broken over time.
Linting in CI means we guarantee links are valid then the documentation is written, but doesn't prevent future rebuilds from succeeding.
PR Checklist: