Skip to content

Commit

Permalink
docs: Run rstcheck on README.rst, too.
Browse files Browse the repository at this point in the history
Let's run rstcheck on the README.rst file in addition to the
documentation sources. One motivation is to help catch issues on the
releases table before merging. We update this table with a script after
cutting new releases, and it has occasionally led to formatting issues
in the past.

Fixes: #13366
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
  • Loading branch information
qmonnet authored and borkmann committed Jun 26, 2023
1 parent e8049d9 commit 5951d1d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Documentation/check-build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ run_linter() {
--ignore-directives "tabs,openapi" \
--ignore-roles "${CONF_PY_ROLES}" \
--ignore-substitutions "${CONF_PY_SUBSTITUTIONS}" \
-r . 2>&1 | \
-r . ../README.rst 2>&1 | \
grep -v 'CRITICAL:rstcheck_core.checker:An `AttributeError` error occured. This is most propably due to a code block directive (code/code-block/sourcecode) without a specified language.'
}

Expand Down

0 comments on commit 5951d1d

Please sign in to comment.