Use pymarkdownlnt add to format.sh

Signed-off-by: Rafael Vasquez <[email protected]>
vllm-project · Jan 9, 2025 · 6f638e9 · 6f638e9
1 parent d4a6be7
commit 6f638e9
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 15 deletions.
diff --git a/.github/workflows/sphinx-lint.yml → .github/workflows/doc-lint.yml b/.github/workflows/sphinx-lint.yml → .github/workflows/doc-lint.yml
@@ -29,11 +29,4 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements-lint.txt
       - name: Linting docs
-        run: tools/sphinx-lint.sh
-  markdown-lint:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-    - uses: DavidAnson/markdownlint-cli2-action@v19
-      with:
-        globs: "docs/**/*.md"
+        run: tools/doc-lint.sh
diff --git a/format.sh b/format.sh
@@ -316,6 +316,6 @@ else
     echo "✨🎉 Format check passed! Congratulations! 🎉✨"
 fi
 
-echo 'vLLM sphinx-lint:'
-tools/sphinx-lint.sh
-echo 'vLLM sphinx-lint: Done'
+echo 'vLLM doc-lint:'
+tools/doc-lint.sh
+echo 'vLLM doc-lint: Done'
diff --git a/requirements-lint.txt b/requirements-lint.txt
@@ -6,7 +6,7 @@ ruff==0.6.5
 codespell==2.3.0
 isort==5.13.2
 clang-format==18.1.5
-sphinx-lint==1.0.0
+pymarkdownlnt==0.9.26
 
 # type checking
 mypy==1.11.1

diff --git a/tools/doc-lint.sh b/tools/doc-lint.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+pymarkdownlnt -d line-length scan docs/ -r
diff --git a/tools/sphinx-lint.sh b/tools/sphinx-lint.sh
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#!/bin/bash

		pymarkdownlnt -d line-length scan docs/ -r