Merge pull request #238 from flatironinstitute/ci_absolute_link_to_docs

prevent absolute links to docs (except badge)

.github/workflows/ci.yml

@@ -49,6 +49,18 @@ jobs:
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+  prevent_docs_absolute_links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Make .sh executable
+        run: chmod +x bash_scripts/prevent_absolute_links_to_docs.sh
+
+      - name: Check links
+        run: ./bash_scripts/prevent_absolute_links_to_docs.sh
+
   check:
     if: ${{ !github.event.pull_request.draft }}
     needs: tox

bash_scripts/prevent_absolute_links_to_docs.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# Check for any unallowed absolute links in documentation excluding the badge.
+if grep -r -E https?://nemos.* docs/ | grep -v "badge"; then
+    echo "Error: Unallowed absolute links found in documentation." >&2
+    exit 1
+else
+    echo "No unallowed absolute links found."
+fi