ci: verify rst documents with lint tool #160
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 patch fixes all rst-lint reported issues with level >= warning: WARNING ./doc/quality.rst:205 Blank line required after table. WARNING ./doc/quality-lowdelay.rst:180 Blank line required after table. WARNING ./doc/benchmarking.rst:2 Duplicate explicit target name: "performance". WARNING ./doc/benchmarking.rst:2 Duplicate explicit target name: "quality". WARNING ./doc/benchmarking.rst:2 Duplicate explicit target name: "performance". WARNING ./doc/benchmarking.rst:2 Duplicate explicit target name: "quality". WARNING ./doc/virtualization.rst:455 Bullet list ends without a blank line; unexpected unindent. WARNING ./doc/benchmarks/intel-data-center-gpu-flex-series/intel-data-center-gpu-flex-series.rst:2 Duplicate explicit target name: "22ww33_419.38_ubuntu514". It also fixes some, but not all issues with level == info. Specifically, "duplicate implicit target name" issues are not fixed if reported for duplicated sub-headers. It occurs that anonymous links should be given with `__` (2 underscores) in rst. There is a reason however to leave non-anonymous links (`_`, i.e. 1 underscore) where possible, which is everywhere except when we get an issue from rst-lint that anonymous link is duplicated. Such cases got fixed in this change. Signed-off-by: Dmitry Rogozhkin <dmitry.v.rogozhkin@intel.com>
Signed-off-by: Dmitry Rogozhkin <dmitry.v.rogozhkin@intel.com>
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.
No description provided.