From 3975a85742b39a29187647468436d5cac792da2c Mon Sep 17 00:00:00 2001 From: Matthias Mair Date: Wed, 26 Apr 2023 23:24:26 +0200 Subject: [PATCH] Check if doc links are broken (#4686) * add check for links * fix style * call silently * add dep * add path * ignore readme as it contains necesarry broken links * fix syntax * check recursevly * run in sync * use linkcheckmd instaead * use sync * add requests * revert fix to check if checks still work * fix lookup * fix old link * run check verbose * run async * remove recurse * introduce error for test * fix link --- .github/workflows/check_docs_config.yaml | 8 ++++++-- docs/docs/extend/integrate.md | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/workflows/check_docs_config.yaml b/.github/workflows/check_docs_config.yaml index 378e8c920d..2efc7b0e9d 100644 --- a/.github/workflows/check_docs_config.yaml +++ b/.github/workflows/check_docs_config.yaml @@ -1,4 +1,4 @@ -name: Documentation Config Checks +name: Documentation Checks on: push: @@ -21,7 +21,11 @@ jobs: uses: actions/setup-python@v2 with: python-version: 3.9 - - name: Run Checks + - name: Check Config run: | pip install pyyaml python docs/ci/check_mkdocs_config.py + - name: Check Links + run: | + pip install linkcheckmd requests + python -m linkcheckmd docs --recurse diff --git a/docs/docs/extend/integrate.md b/docs/docs/extend/integrate.md index 4d59fc48ce..b1143d388e 100644 --- a/docs/docs/extend/integrate.md +++ b/docs/docs/extend/integrate.md @@ -8,7 +8,7 @@ A list of known third-party InvenTree extensions is provided below. If you have ### Ki-nTree -[Ki-nTree](https://github.com/sparkmicro/Ki-nTree/) is a fantastic tool for automated creation of [KiCad](https://kicad-pcb.org/) library parts, with direct integration with InvenTree. +[Ki-nTree](https://github.com/sparkmicro/Ki-nTree/) is a fantastic tool for automated creation of [KiCad](https://www.kicad.org/) library parts, with direct integration with InvenTree. ### PK2InvenTree