👷 Add generate-readme to pre-commit (#1741)

Author: tiangolo

.github/workflows/build-docs.yml

@@ -64,8 +64,6 @@ jobs:
         with:
           key: mkdocs-cards-${{ github.ref }}
           path: .cache
-      - name: Verify README
-        run: uv run ./scripts/docs.py verify-readme
       - name: Build Docs
         run: uv run ./scripts/docs.py build
       - uses: actions/upload-artifact@v6

.pre-commit-config.yaml

@@ -40,3 +40,10 @@ repos:
         name: generate-select
         entry: uv run ./scripts/generate_select.py
         files: ^scripts/generate_select\.py|sqlmodel/sql/_expression_select_gen\.py\.jinja2$
+
+      - id: generate-readme
+        language: unsupported
+        name: generate README.md from index.md
+        entry: uv run ./scripts/docs.py generate-readme
+        files: ^docs/index\.md|scripts/docs\.py$
+        pass_filenames: false