From 9b553acf5c2b7b43c9a5e1176e2e4aa58f97a510 Mon Sep 17 00:00:00 2001 From: Rafael Vasquez Date: Fri, 15 Nov 2024 12:01:58 -0500 Subject: [PATCH 1/5] Add sphinx-lint workflow Signed-off-by: Rafael Vasquez --- .github/workflows/sphinx-lint.yml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/sphinx-lint.yml diff --git a/.github/workflows/sphinx-lint.yml b/.github/workflows/sphinx-lint.yml new file mode 100644 index 000000000000..a19068017fe2 --- /dev/null +++ b/.github/workflows/sphinx-lint.yml @@ -0,0 +1,30 @@ +name: Lint documentation + +on: + push: + branches: + - main + paths: + - "docs/**" + pull_request: + branches: + - main + +jobs: + doc8: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.12"] + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install sphinx-lint + - name: Linting docs + run: sphinx-lint docs From 3508fe2a151ac99a2b202b8b8bc42b57dbdf2c71 Mon Sep 17 00:00:00 2001 From: Russell Bryant Date: Wed, 13 Nov 2024 14:57:52 -0500 Subject: [PATCH 2/5] format.sh: Add sphinx-lint Run `sphinx-lint` from `format.sh` as a quick check for any doc formatting mistakes. Signed-off-by: Russell Bryant (cherry picked from commit 1100f67ee909254c90bbf5d678f40535d2dd8d58) --- format.sh | 6 ++++++ requirements-lint.txt | 1 + tools/sphinx-lint.sh | 3 +++ 3 files changed, 10 insertions(+) create mode 100755 tools/sphinx-lint.sh diff --git a/format.sh b/format.sh index a57882d2ac3f..eaff6b969932 100755 --- a/format.sh +++ b/format.sh @@ -41,6 +41,7 @@ MYPY_VERSION=$(mypy --version | awk '{print $2}') CODESPELL_VERSION=$(codespell --version) ISORT_VERSION=$(isort --vn) CLANGFORMAT_VERSION=$(clang-format --version | awk '{print $3}') +SPHINX_LINT_VERSION=$(sphinx-lint --version | awk '{print $2}') # # params: tool name, tool version, required version tool_version_check() { @@ -57,6 +58,7 @@ tool_version_check "mypy" "$MYPY_VERSION" tool_version_check "isort" "$ISORT_VERSION" tool_version_check "codespell" "$CODESPELL_VERSION" tool_version_check "clang-format" "$CLANGFORMAT_VERSION" +tool_version_check "sphinx-lint" "$SPHINX_LINT_VERSION" YAPF_FLAGS=( '--recursive' @@ -309,3 +311,7 @@ if ! git diff --quiet &>/dev/null; then else echo "✨🎉 Format check passed! Congratulations! 🎉✨" fi + +echo 'vLLM sphinx-lint:' +tools/sphinx-lint.sh +echo 'vLLM sphinx-lint: Done' diff --git a/requirements-lint.txt b/requirements-lint.txt index f9132bbf9643..711bb50a0e93 100644 --- a/requirements-lint.txt +++ b/requirements-lint.txt @@ -6,6 +6,7 @@ ruff==0.6.5 codespell==2.3.0 isort==5.13.2 clang-format==18.1.5 +sphinx-lint==1.0.0 # type checking mypy==1.11.1 diff --git a/tools/sphinx-lint.sh b/tools/sphinx-lint.sh new file mode 100755 index 000000000000..04f8075c5527 --- /dev/null +++ b/tools/sphinx-lint.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +sphinx-lint --disable trailing-whitespace,missing-final-newline docs From fb41d214495d4876b2a12ed8371cb2b02cca6b96 Mon Sep 17 00:00:00 2001 From: Rafael Vasquez Date: Mon, 18 Nov 2024 10:47:51 -0500 Subject: [PATCH 3/5] Use linting script in action Signed-off-by: Rafael Vasquez --- .github/workflows/sphinx-lint.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/sphinx-lint.yml b/.github/workflows/sphinx-lint.yml index a19068017fe2..c82a7ba043b4 100644 --- a/.github/workflows/sphinx-lint.yml +++ b/.github/workflows/sphinx-lint.yml @@ -25,6 +25,6 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install sphinx-lint + pip install -r requirements-lint.txt - name: Linting docs - run: sphinx-lint docs + run: tools/sphinx-lint.sh From c4cd8496dac66581aa9e386c58f783ab88d55f03 Mon Sep 17 00:00:00 2001 From: Rafael Vasquez Date: Mon, 18 Nov 2024 10:49:05 -0500 Subject: [PATCH 4/5] Fix job name Signed-off-by: Rafael Vasquez --- .github/workflows/sphinx-lint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sphinx-lint.yml b/.github/workflows/sphinx-lint.yml index c82a7ba043b4..e3041fa7b978 100644 --- a/.github/workflows/sphinx-lint.yml +++ b/.github/workflows/sphinx-lint.yml @@ -11,7 +11,7 @@ on: - main jobs: - doc8: + sphinx-lint: runs-on: ubuntu-latest strategy: matrix: From aaee36e3fc8ee68a0435a73cdf415db58ea8a9ba Mon Sep 17 00:00:00 2001 From: Rafael Vasquez Date: Mon, 18 Nov 2024 10:59:14 -0500 Subject: [PATCH 5/5] Set path for PRs Signed-off-by: Rafael Vasquez --- .github/workflows/sphinx-lint.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/sphinx-lint.yml b/.github/workflows/sphinx-lint.yml index e3041fa7b978..e0bb24276a65 100644 --- a/.github/workflows/sphinx-lint.yml +++ b/.github/workflows/sphinx-lint.yml @@ -9,6 +9,8 @@ on: pull_request: branches: - main + paths: + - "docs/**" jobs: sphinx-lint: