mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 14:03:30 +00:00
1a83b32da5
This is fairly often -- though not always! -- failing, with a nasty failure mode where it takes like 6 minutes to time out. See discussion on #7748 (search for "bad link"). Actually, after seeing it happen just now when running test-documentation on my laptop, on some other link, it occurs to me that I've seen this before -- it's fairly common in Travis, too. It's just that it doesn't actually cause the build to fail :-/, and on Travis we haven't been paying as close attention to slow builds as we are on Circle right now.
50 lines
1.3 KiB
Bash
Executable File
50 lines
1.3 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
set -e
|
|
|
|
color_message () {
|
|
local color_code="$1" message="$2"
|
|
echo -e "\e[${color_code}m${message}\e[0m" >&2
|
|
}
|
|
|
|
case $1 in
|
|
-h|--help)
|
|
echo "--help, -h show this help message and exit"
|
|
echo "--loglevel=LEVEL, -L LEVEL log level (default: ERROR)"
|
|
exit 0
|
|
;;
|
|
-L|--loglevel)
|
|
loglevel="$1 $2"
|
|
;;
|
|
--skip-check-links)
|
|
skip_check_links=1
|
|
;;
|
|
esac
|
|
|
|
cd "$(dirname "$0")"/../docs
|
|
rm -rf _build
|
|
|
|
# collapse_navigation is set to False in conf.py to improve sidebar navigation for users.
|
|
# However, we must change its value to True before we begin testing links.
|
|
# Otherwise, sphinx would generate a large number of links we don't need to test.
|
|
# The crawler would take a very long time to finish and TravisCI would fail as a result.
|
|
sphinx-build -j8 -b html -d _build/doctrees -D html_theme_options.collapse_navigation=True . _build/html
|
|
|
|
if [ -n "$skip_check_links" ]; then
|
|
color_message 94 "Skipped testing links in documentation."
|
|
exit 0
|
|
fi
|
|
|
|
color_message 94 "Testing links in documentation..."
|
|
|
|
cd ../tools/documentation_crawler
|
|
set +e
|
|
scrapy crawl_with_status documentation_crawler $loglevel
|
|
result=$?
|
|
if [ "$result" = 1 ]; then
|
|
color_message 91 "Failed!"
|
|
exit 1
|
|
else
|
|
color_message 92 "Passed!"
|
|
exit 0
|
|
fi
|