Merge pull request #2480 from VWS-Python/sphinx-lint

Add sphinx-lint

Author: adamtheturtle

.pre-commit-config.yaml

@@ -1,6 +1,42 @@
 ---
 fail_fast: true
 
+# We use system Python, with required dependencies specified in pyproject.toml.
+# We therefore cannot use those dependencies in pre-commit CI.
+ci:
+  skip:
+    - actionlint
+    - sphinx-lint
+    - check-manifest
+    - custom-linters
+    - deptry
+    - doc8
+    - docs
+    - interrogate
+    - interrogate-docs
+    - linkcheck
+    - mypy
+    - mypy-docs
+    - pylint
+    - pyproject-fmt-fix
+    - pyright
+    - pyright-docs
+    - pyright-verifytypes
+    - pyroma
+    - ruff-check-fix
+    - ruff-check-fix-docs
+    - ruff-format-fix
+    - ruff-format-fix-docs
+    - docformatter
+    - shellcheck
+    - shellcheck-docs
+    - shfmt
+    - shfmt-docs
+    - spelling
+    - vulture
+    - vulture-docs
+    - yamlfix
+
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 default_install_hook_types: [pre-commit, pre-push, commit-msg]
@@ -49,29 +85,29 @@ repos:
         language: python
         types_or: [yaml, python]
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: actionlint
         name: actionlint
         entry: uv run --extra=dev actionlint
         language: python
         pass_filenames: false
         types_or: [yaml]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: docformatter
         name: docformatter
         entry: uv run --extra=dev -m docformatter --in-place
         language: python
         types_or: [python]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: shellcheck
         name: shellcheck
         entry: uv run --extra=dev shellcheck --shell=bash
         language: python
         types_or: [shell]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: shellcheck-docs
         name: shellcheck-docs
@@ -80,22 +116,22 @@ repos:
           --shell=bash --exclude=SC2215"
         language: python
         types_or: [markdown, rst]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: shfmt
         name: shfmt
         entry: shfmt --write --space-redirects --indent=4
         language: python
         types_or: [shell]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: shfmt-docs
         name: shfmt-docs
         entry: uv run --extra=dev doccmd --language=shell --language=console --skip-marker=shfmt
           --no-pad-file --command="shfmt --write --space-redirects --indent=4"
         language: python
         types_or: [markdown, rst]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: mypy
         name: mypy
@@ -104,7 +140,7 @@ repos:
         language: python
         types_or: [python, toml]
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: mypy-docs
         name: mypy-docs
@@ -119,7 +155,7 @@ repos:
         entry: uv run --extra=dev -m check_manifest
         language: python
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: pyright
         name: pyright
@@ -128,7 +164,7 @@ repos:
         language: python
         types_or: [python, toml]
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: pyright-docs
         name: pyright-docs
@@ -144,46 +180,46 @@ repos:
         language: python
         pass_filenames: false
         types_or: [python]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: vulture
         name: vulture
         entry: uv run --extra=dev -m vulture .
         language: python
         types_or: [python]
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: vulture-docs
         name: vulture docs
         entry: uv run --extra=dev doccmd --language=python --command="vulture"
         language: python
         types_or: [python]
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: pyroma
         name: pyroma
         entry: uv run --extra=dev -m pyroma --min 10 .
         language: python
         pass_filenames: false
         types_or: [toml]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: deptry
         name: deptry
         entry: uv run --extra=dev -m deptry src/
         language: python
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: pylint
         name: pylint
         entry: uv run --extra=dev -m pylint *.py src/ tests/ docs/ ci/ admin/
         language: python
         stages: [manual]
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: pylint-docs
         name: pylint-docs
@@ -197,36 +233,36 @@ repos:
         entry: uv run --extra=dev -m ruff check --fix
         language: python
         types_or: [python]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: ruff-check-fix-docs
         name: Ruff check fix docs
         entry: uv run --extra=dev doccmd --language=python --command="ruff check --fix"
         language: python
         types_or: [markdown, rst]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: ruff-format-fix
         name: Ruff format
         entry: uv run --extra=dev -m ruff format
         language: python
         types_or: [python]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: ruff-format-fix-docs
         name: Ruff format docs
         entry: uv run --extra=dev doccmd --language=python --no-pad-file --command="ruff
           format"
         language: python
         types_or: [markdown, rst]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: doc8
         name: doc8
         entry: uv run --extra=dev -m doc8
         language: python
         types_or: [rst]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: interrogate
         name: interrogate
@@ -240,7 +276,7 @@ repos:
         entry: uv run --extra=dev doccmd --language=python --command="interrogate"
         language: python
         types_or: [markdown, rst]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: pyproject-fmt-fix
         name: pyproject-fmt
@@ -256,7 +292,7 @@ repos:
         types_or: [rst]
         stages: [manual]
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: spelling
         name: spelling
@@ -265,54 +301,27 @@ repos:
         types_or: [rst]
         stages: [manual]
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: docs
         name: Build Documentation
         entry: make docs
         language: python
         stages: [manual]
         pass_filenames: false
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
       - id: yamlfix
         name: pyproject-fmt
         entry: uv run --extra=dev yamlfix
         language: python
         types_or: [yaml]
-        additional_dependencies: [uv==0.4.25]
+        additional_dependencies: [uv==0.5.14]
 
-# We use system Python, with required dependencies specified in pyproject.toml.
-# We therefore cannot use those dependencies in pre-commit CI.
-ci:
-  skip:
-    - actionlint
-    - check-manifest
-    - custom-linters
-    - deptry
-    - doc8
-    - docs
-    - interrogate
-    - interrogate-docs
-    - linkcheck
-    - mypy
-    - mypy-docs
-    - pylint
-    - pyproject-fmt-fix
-    - pyright
-    - pyright-docs
-    - pyright-verifytypes
-    - pyroma
-    - ruff-check-fix
-    - ruff-check-fix-docs
-    - ruff-format-fix
-    - ruff-format-fix-docs
-    - docformatter
-    - shellcheck
-    - shellcheck-docs
-    - shfmt
-    - shfmt-docs
-    - spelling
-    - vulture
-    - vulture-docs
-    - yamlfix
+      - id: sphinx-lint
+        name: sphinx-lint
+        entry: uv run --extra=dev sphinx-lint --enable=all --disable=line-too-long
+          README.rst CHANGELOG.rst
+        language: python
+        types_or: [rst]
+        additional_dependencies: [uv==0.5.14]

pyproject.toml

@@ -89,6 +89,7 @@ optional-dependencies.dev = [
     "shfmt-py==3.7.0.1",
     "sphinx==8.1.3",
     "sphinx-copybutton==0.5.2",
+    "sphinx-lint==1.0.0",
     "sphinx-paramlinks==0.6",
     "sphinx-substitution-extensions==2025.1.2",
     "sphinx-toolbox==3.8.1",