docs: Check links

Use a GitHub Action to verify the presence of broken links in `.rst` and `.md` files. Signed-off-by: Dimitris Poulopoulos <[email protected]>
dpoulopoulos · Dec 20, 2024 · 5e3503a · 5e3503a
1 parent fb8f180
commit 5e3503a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -10,6 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - name: Check links
+        id: lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+          # Documentation: https://github.com/lycheeverse/lychee?tab=readme-ov-file#commandline-parameters
+          args: --base . --verbose --no-progress './**/*.md'  './**/*.rst' --exclude 'mailto:|localhost'
       - uses: actions/setup-python@v3
       - name: Install dependencies
         run: |