Ignore link check for all localhost/0.0.0.0/127.0.0.1 urls (#1226)

neuralmagic · Sep 1, 2023 · cbb8823 · cbb8823
1 parent fa73631
commit cbb8823
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 8 deletions.
diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml
@@ -19,3 +19,4 @@ jobs:
     - uses: gaurav-nelson/github-action-markdown-link-check@v1
       with:
         use-quiet-mode: 'yes'
+        config-file: '.github/workflows/mlc_config.json'
diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json
@@ -0,0 +1,13 @@
+{
+    "ignorePatterns": [
+        {
+            "pattern": ".*localhost.*"
+        },
+        {
+            "pattern": ".*127\\.0\\.0\\.1.*"
+        },
+        {
+            "pattern": ".*0\\.0\\.0\\.0.*"
+        }
+    ]
+}
diff --git a/docs/use-cases/cv/image-classification.md b/docs/use-cases/cv/image-classification.md
@@ -212,9 +212,9 @@ deepsparse.server \
   --task image_classification \
   --model_path zoo:cv/classification/resnet_v1-50/pytorch/sparseml/imagenet/pruned95_quant-none
 ```
-<!-- markdown-link-check-disable -->
+
 You should see Uvicorn report that it is running on http://0.0.0.0:5543. Once launched, a /docs path is created with full endpoint descriptions and support for making sample requests.
-<!-- markdown-link-check-enable -->
+
 
 Here is an example client request, using the Python requests library for formatting the HTTP:
 

diff --git a/docs/use-cases/nlp/question-answering.md b/docs/use-cases/nlp/question-answering.md
@@ -221,9 +221,9 @@ deepsparse.server \
   --task question-answering \
   --model_path zoo:nlp/question_answering/obert-base/pytorch/huggingface/squad/pruned90_quant-none # or path/to/onnx
 ```
-<!-- markdown-link-check-disable -->
+
 You should see Uvicorn report that it is running on http://0.0.0.0:5543. Once launched, a /docs path is created with full endpoint descriptions and support for making sample requests.
-<!-- markdown-link-check-enable -->
+
 
 Here is an example client request, using the Python requests library for formatting the HTTP:
 ```python

diff --git a/docs/use-cases/nlp/token-classification.md b/docs/use-cases/nlp/token-classification.md
@@ -219,9 +219,9 @@ deepsparse.server \
   --task token_classification \
   --model_path "zoo:nlp/token_classification/obert-base/pytorch/huggingface/conll2003/pruned90_quant-none" # or path/to/onnx
 ```
-<!-- markdown-link-check-disable -->
+
 You should see Uvicorn report that it is running on http://0.0.0.0:5543. Once launched, a /docs path is created with full endpoint descriptions and support for making sample requests.
-<!-- markdown-link-check-enable -->
+
 
 Here is an example client request, using the Python requests library for formatting the HTTP:
 ```python

diff --git a/docs/user-guide/deepsparse-docker.md b/docs/user-guide/deepsparse-docker.md
@@ -57,9 +57,9 @@ Alternatively, you can run the two commands in a single line:
 ```bash 
 docker container run -p 5543:5543 deepsparse_docker deepsparse.server --task sentiment_analysis --model_path "zoo:nlp/sentiment_analysis/distilbert-none/pytorch/huggingface/sst2/pruned90-none"
 ```
-<!-- markdown-link-check-disable -->
+
 You should see Uvicorn report that it is running on http://0.0.0.0:5543. Once launched, a `/docs` path is created with full endpoint descriptions and support for making sample requests.
-<!-- markdown-link-check-enable -->
+
 
 Here is an example client request, using the Python requests library for formatting the HTTP:
 ```python