Merge pull request #13485 from simondeziel/make-doc

github: run the doc link checker on PRs only

.github/workflows/tests.yml

@@ -504,6 +504,8 @@ jobs:
           woke-args: "*.md **/*.md -c https://github.com/canonical/Inclusive-naming/raw/main/config.yml"
 
       - name: Run link checker
+        # Run link checker on PRs only
+        if: ${{ github.event_name != 'push' }}
         run: |
           set -eux
           make doc-linkcheck

Makefile

@@ -155,7 +155,7 @@ doc-objects:
 
 .PHONY: doc-serve
 doc-serve:
-	cd doc/html; python3 -m http.server 8001
+	cd doc/html; python3 -m http.server --bind 127.0.0.1 8001
 
 .PHONY: doc-spellcheck
 doc-spellcheck: doc

doc/.sphinx/.markdownlint/doc-lint.sh

@@ -22,6 +22,14 @@ mdl .tmp/doc -sdoc/.sphinx/.markdownlint/style.rb -udoc/.sphinx/.markdownlint/ru
 
 sed -i '/^$/,$d' .tmp/errors.txt
 
+# Check for unneeded exceptions
+unneeded_exceptions="$(grep -vxFf .tmp/errors.txt doc/.sphinx/.markdownlint/exceptions.txt)" || true
+if [ -n "${unneeded_exceptions}" ]; then
+    echo "Failed due to unneeded exceptions rules!"
+    echo "${unneeded_exceptions}"
+    exit 1
+fi
+
 filtered_errors="$(grep -vxFf doc/.sphinx/.markdownlint/exceptions.txt .tmp/errors.txt)" || true
 
 if [ -z "$filtered_errors" ]; then

doc/.sphinx/.markdownlint/exceptions.txt

@@ -8,4 +8,3 @@
 .tmp/doc/howto/network_forwards.md:73: MD005 Inconsistent indentation for list items at the same level
 .tmp/doc/howto/network_forwards.md:67: MD032 Lists should be surrounded by blank lines
 .tmp/doc/howto/network_forwards.md:72: MD032 Lists should be surrounded by blank lines
-.tmp/doc/contributing.md:9: MD002 First header should be a top level header