From f1093b358808a628816c3f084b1d2d5974dd96c6 Mon Sep 17 00:00:00 2001 From: Sebastian Castro Date: Sun, 17 Nov 2024 18:10:10 -0500 Subject: [PATCH] Update htmlproofer.sh script to not bark at warnings --- htmlproofer.sh | 16 +++++++++------- requirements.txt | 6 +++--- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/htmlproofer.sh b/htmlproofer.sh index ca916ad82a..d2d904918b 100755 --- a/htmlproofer.sh +++ b/htmlproofer.sh @@ -21,7 +21,7 @@ rm -rf build # Build API docs mkdir -p build/html pushd build/html -git clone https://github.com/ros-planning/moveit2 -b $MOVEIT_BRANCH --depth 1 +git clone https://github.com/moveit/moveit2 -b $MOVEIT_BRANCH --depth 1 pushd moveit2 sed -i "s/HTML_EXTRA_STYLESHEET =.*/HTML_EXTRA_STYLESHEET = ..\/..\/..\/theme.css/g" Doxyfile DOXYGEN_OUTPUT_DIRECTORY="../api" doxygen @@ -30,19 +30,21 @@ rm -rf moveit2 popd # Test build with non-ROS wrapped Sphinx command to allow warnings and errors to be caught -sphinx-build -W -b html . build/html +# TODO: Re-add the -W flag so that all warnings are treated as errors. +sphinx-build -b html . build/html # Replace Edit on Github links with local file paths -grep -rl 'https:\/\/github.com\/ros-planning\/moveit2_tutorials\/blob\/main\/' ./build/ | \ - xargs sed -i "s|https://github.com/ros-planning/moveit2_tutorials/blob/main/|file://$PWD|g" +grep -rl 'https:\/\/github.com\/moveit\/moveit2_tutorials\/blob\/main\/' ./build/ | \ + xargs sed -i "s|https://github.com/moveit/moveit2_tutorials/blob/main/|file://$PWD|g" # Replace internal links with local file paths -grep -rl 'https:\/\/moveit.picknik.ai\/humble\/' ./build/ | \ - xargs sed -i "s|https://moveit.picknik.ai/humble/|file://$PWD|g" +grep -rl 'https:\/\/moveit.picknik.ai\/rolling\/' ./build/ | \ + xargs sed -i "s|https://moveit.picknik.ai/rolling/|file://$PWD|g" # Run HTML tests on generated build output to check for 404 errors, etc +# 429 or 403 - happens when GitHub rate-limits requests htmlproofer ./build \ - --only-4xx --check-html --http-status-ignore "429" \ + --only-4xx --check-html --http-status-ignore "429" --http-status-ignore "403" \ --file-ignore ./build/html/genindex.html,./build/html/search.html,/html/api/ \ --alt-ignore '/.*/' --url-ignore '#' diff --git a/requirements.txt b/requirements.txt index 163e9dd054..81cc63c63c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,8 @@ pip -docutils==0.18.1 +docutils sphinx>=5.0.0 -sphinx-tabs==3.4.4 +sphinx-tabs sphinx-multiversion sphinx-rtd-theme sphinx-copybutton -sphinxcontrib-doxylink +sphinxcontrib-doxylink@git+https://github.com/sea-bass/doxylink.git@fix-parse-tag-file