CI/CD: Added sphinx-lint

Author: Seluj78

.github/workflows/linting.yml

@@ -109,3 +109,29 @@ jobs:
           pip install types-flask
       - name: Lint with mypy
         run: mypy flask_utils
+
+  lint-sphinx:
+    name: Checking documentation with Sphinx
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+          cache-dependency-path: |
+            requirements.txt
+            requirements-dev.txt
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+      - name: Lint with sphinx
+        run: sphinx-lint -i .venv -i .tox

.pre-commit-config.yaml

@@ -45,3 +45,10 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: v0.9.1
+    hooks:
+      - id: sphinx-lint
+        args:
+          - -i .venv
+          - -i .tox

requirements-dev.txt

@@ -7,4 +7,5 @@ pre-commit
 pytest
 pytest-flask
 reorder-python-imports
+sphinx-lint
 tox