From 27e3e5680001f86cbfb82c1813376e702814ab95 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 16 Jan 2022 14:07:46 +0100 Subject: [PATCH] [mod] CI target test.rst: test reST markup of README.rst Signed-off-by: Markus Heiser --- Makefile | 6 +++--- manage | 12 ++++++++++++ 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 20f89a79b..9d49e8d5f 100644 --- a/Makefile +++ b/Makefile @@ -50,8 +50,8 @@ search.checker.%: install $(Q)./manage pyenv.cmd searx-checker -v "$(subst _, ,$(patsubst search.checker.%,%,$@))" PHONY += test ci.test test.shell -ci.test: test.yamllint test.black test.pylint test.unit test.robot -test: test.yamllint test.black test.pylint test.unit test.robot test.shell +ci.test: test.yamllint test.black test.pylint test.unit test.robot test.rst +test: test.yamllint test.black test.pylint test.unit test.robot test.rst test.shell test.shell: $(Q)shellcheck -x -s dash \ dockerfiles/docker-entrypoint.sh @@ -86,7 +86,7 @@ MANAGE += py.build py.clean MANAGE += pyenv pyenv.install pyenv.uninstall MANAGE += pypi.upload pypi.upload.test MANAGE += format.python -MANAGE += test.yamllint test.pylint test.black test.unit test.coverage test.robot test.clean +MANAGE += test.yamllint test.pylint test.black test.unit test.coverage test.robot test.rst test.clean MANAGE += themes.all themes.oscar themes.simple themes.simple.test pygments.less MANAGE += static.build.commit static.build.drop static.build.restore MANAGE += nvm.install nvm.clean nvm.status nvm.nodejs diff --git a/manage b/manage index 1643802f4..88ac75aac 100755 --- a/manage +++ b/manage @@ -46,6 +46,10 @@ while IFS= read -r line; do YAMLLINT_FILES+=("$line") done <<< "$(git ls-files './tests/*.yml' './searx/*.yml' './utils/templates/etc/searxng/*.yml')" +RST_FILES=( + 'README.rst' +) + PYLINT_SEARXNG_DISABLE_OPTION="\ I,C,R,\ W0105,W0212,W0511,W0603,W0613,W0621,W0702,W0703,W1401,\ @@ -103,6 +107,7 @@ test.: unit : run unit tests coverage : run unit tests with coverage robot : run robot test + rst : test .rst files incl. README.rst clean : clean intermediate test stuff themes.: all : build all themes @@ -707,6 +712,13 @@ test.robot() { dump_return $? } +test.rst() { + build_msg TEST "[reST markup] ${RST_FILES[@]}" + for rst in "${RST_FILES[@]}"; do + pyenv.cmd rst2html.py --halt error "$rst" > /dev/null || die 42 "fix issue in $rst" + done +} + test.clean() { build_msg CLEAN "test stuff" rm -rf geckodriver.log .coverage coverage/