docs: Make link checking easier to enable

- Enable link checking when ever run as: LINKCHECK=1 ./make_docs
Kintyre · Oct 5, 2023 · 792e8de · 792e8de
1 parent fe7723d
commit 792e8de
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/make_docs b/make_docs
@@ -56,6 +56,10 @@ sphinx-apidoc -f -o "docs/source/api" ksconf 'ksconf/ext'
 
 echo "Building local html docs and opening browser window"
 # Or, something like:   make html
-LINKCHECK_ARGS=""
-# LINKCHECK_ARGS="-b linkcheck"
-sphinx-autobuild --port 9999 --watch ksconf docs/source docs/build/html ${LINKCHECK_ARGS} --open-browser
+LINKCHECK_ARGS=()
+
+if [[ "z$LINKCHECK" != "z" ]]; then
+    LINKCHECK_ARGS=(-b linkcheck)
+fi
+
+sphinx-autobuild --port 9999 --watch ksconf docs/source docs/build/html "${LINKCHECK_ARGS[@]}" --open-browser