Add Sphinx heading underline linter and fix heading lengths #2916
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.
Purpose of PR?:
Fixes #2812
Does this PR introduce a breaking change?
No. Fixes Incorrect heading markup
If the changes in this PR are manually verified, list down the scenarios covered::
Adds a heading_linter.py which fixes the heading lengths according to Sphinx
Additional information for reviewer? :
Does this PR results in some Documentation changes?
Run heading_linter.py to find out the errors
Run heading_linter.py --fix to fix the changes
Checklist:
<type>: <subject>