chore: Template upgrade

pawamoy · pawamoy · commit 0a3d7d4ad010 · 2025-08-05T15:47:28.000+02:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier.
-_commit: 1.7.1
+_commit: 1.8.6
 _src_path: gh:pawamoy/copier-uv
 author_email: dev@pawamoy.fr
 author_fullname: Timothée Mazzucotelli
diff --git a/Makefile b/Makefile
@@ -2,6 +2,13 @@
 # the `make` command will point at the `scripts/make` shell script.
 # This Makefile is just here to allow auto-completion in the terminal.
 
+default: help
+	@echo
+	@echo 'Enable direnv in your shell to use the `make` command: `direnv allow`'
+	@echo 'Or use `python scripts/make ARGS` to run the commands/tasks directly.'
+
+.DEFAULT_GOAL: default
+
 actions = \
 	allrun \
 	changelog \
diff --git a/docs/css/mkdocstrings.css b/docs/css/mkdocstrings.css
@@ -24,4 +24,49 @@ a.autorefs-external::after {
 a.external:hover::after,
 a.autorefs-external:hover::after {
   background-color: var(--md-accent-fg-color);
-}
+}
+
+/* Tree-like output for backlinks. */
+.doc-backlink-list {
+  --tree-clr: var(--md-default-fg-color);
+  --tree-font-size: 1rem;
+  --tree-item-height: 1;
+  --tree-offset: 1rem;
+  --tree-thickness: 1px;
+  --tree-style: solid;
+  display: grid;
+  list-style: none !important;
+}
+
+.doc-backlink-list li > span:first-child {
+  text-indent: .3rem;
+}
+.doc-backlink-list li {
+  padding-inline-start: var(--tree-offset);
+  border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
+  position: relative;
+  margin-left: 0 !important;
+
+  &:last-child {
+    border-color: transparent;
+  }
+  &::before{
+    content: '';
+    position: absolute;
+    top: calc(var(--tree-item-height) / 2 * -1 * var(--tree-font-size) + var(--tree-thickness));
+    left: calc(var(--tree-thickness) * -1);
+    width: calc(var(--tree-offset) + var(--tree-thickness) * 2);
+    height: calc(var(--tree-item-height)  * var(--tree-font-size));
+    border-left: var(--tree-thickness) var(--tree-style) var(--tree-clr);
+    border-bottom: var(--tree-thickness) var(--tree-style) var(--tree-clr);
+  }
+  &::after{
+    content: '';
+    position: absolute;
+    border-radius: 50%;
+    background-color: var(--tree-clr);
+    top: calc(var(--tree-item-height) / 2 * 1rem);
+    left: var(--tree-offset) ;
+    translate: calc(var(--tree-thickness) * -1) calc(var(--tree-thickness) * -1);
+  }
+}
diff --git a/docs/reference/api.md b/docs/reference/api.md
@@ -1,3 +1,9 @@
+---
+title: API reference
+hide:
+- navigation
+---
+
 # ::: griffe_pydantic
     options:
         show_submodules: true
diff --git a/duties.py b/duties.py
@@ -237,7 +237,7 @@ def coverage(ctx: Context) -> None:
 
 
 @duty
-def test(ctx: Context, *cli_args: str, match: str = "") -> None:
+def test(ctx: Context, *cli_args: str, match: str = "") -> None:  # noqa: PT028
     """Run the test suite.
 
     Parameters:
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -19,7 +19,7 @@ nav:
   - Changelog: changelog.md
   - Credits: credits.md
   - License: license.md
-- API reference: reference/griffe_pydantic.md
+- API reference: reference/api.md
 - Development:
   - Contributing: contributing.md
   - Code of Conduct: code_of_conduct.md
@@ -106,6 +106,7 @@ markdown_extensions:
 
 plugins:
 - search
+- autorefs
 - markdown-exec
 - section-index
 - coverage
@@ -118,6 +119,7 @@ plugins:
         - https://mkdocstrings.github.io/griffe/objects.inv
         - https://docs.pydantic.dev/latest/objects.inv
         options:
+          backlinks: tree
           docstring_options:
             ignore_init_summary: true
           docstring_section_style: list
@@ -135,11 +137,12 @@ plugins:
           signature_crossrefs: true
           summary: true
 - llmstxt:
-    files:
-    - output: llms-full.txt
-      inputs:
+    full_output: llms-full.txt
+    sections:
+      Usage:
       - index.md
-      - reference/**.md
+      API:
+      - reference/api.md
 - git-revision-date-localized:
     enabled: !ENV [DEPLOY, false]
     enable_creation_date: true
diff --git a/pyproject.toml b/pyproject.toml
@@ -52,7 +52,7 @@ getter = "scripts.get_version:get_version"
 
 [tool.pdm.build]
 # Include as much as possible in the source distribution, to help redistributors.
-excludes = ["**/.pytest_cache"]
+excludes = ["**/.pytest_cache", "**/.mypy_cache"]
 source-includes = [
     "config",
     "docs",
@@ -98,11 +98,11 @@ ci = [
     "mkdocs>=1.6",
     "mkdocs-coverage>=1.0",
     "mkdocs-git-revision-date-localized-plugin>=1.2",
-    "mkdocs-llmstxt>=0.1",
+    "mkdocs-llmstxt>=0.2",
     "mkdocs-material>=9.5",
     "mkdocs-minify-plugin>=0.8",
-    "mkdocstrings[python]>=0.28",
     "mkdocs-section-index>=0.3",
+    "mkdocstrings[python]>=0.29",
     # YORE: EOL 3.10: Remove line.
     "tomli>=2.0; python_version < '3.11'",
 ]
diff --git a/scripts/gen_api_ref.py b/scripts/gen_api_ref.py
diff --git a/scripts/get_version.py b/scripts/get_version.py
@@ -4,7 +4,12 @@
 from contextlib import suppress
 from pathlib import Path
 
-from pdm.backend.hooks.version import SCMVersion, Version, default_version_formatter, get_version_from_scm
+from pdm.backend.hooks.version import (  # ty: ignore[unresolved-import]
+    SCMVersion,
+    Version,
+    default_version_formatter,
+    get_version_from_scm,
+)
 
 _root = Path(__file__).parent.parent
 _changelog = _root / "CHANGELOG.md"
diff --git a/scripts/insiders.py b/scripts/insiders.py
@@ -168,6 +168,6 @@ def load_json(url: str) -> str | list | dict:
 ongoing_goals = [goal for goal in goals.values() if not goal.complete]
 unreleased_features = sorted(
     (ft for ft in feature_list(ongoing_goals) if ft.since),
-    key=lambda ft: cast(date, ft.since),
+    key=lambda ft: cast("date", ft.since),
     reverse=True,
 )
diff --git a/scripts/make.py b/scripts/make.py
@@ -144,19 +144,31 @@ def main() -> int:
         cmd = args.pop(0)
 
         if cmd == "run":
-            run("default", *args)
+            if not args:
+                print("make: run: missing command", file=sys.stderr)
+                return 1
+            run("default", *args)  # ty: ignore[missing-argument]
             return 0
 
         if cmd == "multirun":
-            multirun(*args)
+            if not args:
+                print("make: run: missing command", file=sys.stderr)
+                return 1
+            multirun(*args)  # ty: ignore[missing-argument]
             return 0
 
         if cmd == "allrun":
-            allrun(*args)
+            if not args:
+                print("make: run: missing command", file=sys.stderr)
+                return 1
+            allrun(*args)  # ty: ignore[missing-argument]
             return 0
 
         if cmd.startswith("3."):
-            run(cmd, *args)
+            if not args:
+                print("make: run: missing command", file=sys.stderr)
+                return 1
+            run(cmd, *args)  # ty: ignore[missing-argument]
             return 0
 
         opts = []
diff --git a/src/griffe_pydantic/_internal/debug.py b/src/griffe_pydantic/_internal/debug.py
@@ -85,7 +85,7 @@ def _get_debug_info() -> _Environment:
         interpreter_version=py_version,
         interpreter_path=sys.executable,
         platform=platform.platform(),
-        variables=[_Variable(var, val) for var in variables if (val := os.getenv(var))],
+        variables=[_Variable(var, val) for var in variables if (val := os.getenv(var))],  # ty: ignore[invalid-argument-type]
         packages=[_Package(pkg, _get_version(pkg)) for pkg in packages],
     )
 
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -91,7 +91,7 @@ def _fixture_public_objects(public_api: griffe.Module) -> list[griffe.Object | g
 def _fixture_inventory() -> Inventory:
     inventory_file = Path(__file__).parent.parent / "site" / "objects.inv"
     if not inventory_file.exists():
-        raise pytest.skip("The objects inventory is not available.")
+        pytest.skip("The objects inventory is not available.")  # ty: ignore[call-non-callable]
     with inventory_file.open("rb") as file:
         return Inventory.parse_sphinx(file)
 
@@ -165,8 +165,12 @@ def test_inventory_matches_api(
         # YORE: Bump 2: Remove block.
         if item.name.startswith(ignore) or item.name in ignore_paths:
             continue
-
-        if item.domain == "py" and "(" not in item.name:
+        
+        if (
+            item.domain == "py"
+            and "(" not in item.name
+            and (item.name == "griffe_pydantic" or item.name.startswith("griffe_pydantic."))
+        ):
             obj = loader.modules_collection[item.name]
             if obj.path not in public_api_paths and not any(path in public_api_paths for path in obj.aliases):
                 not_in_api.append(item.name)

Original file line number	Diff line number	Diff line change
`@@ -168,6 +168,6 @@ def load_json(url: str) -> str \| list \| dict:`
`168`	`168`	`ongoing_goals = [goal for goal in goals.values() if not goal.complete]`
`169`	`169`	`unreleased_features = sorted(`
`170`	`170`	`(ft for ft in feature_list(ongoing_goals) if ft.since),`
`171`		`- key=lambda ft: cast(date, ft.since),`
	`171`	`+ key=lambda ft: cast("date", ft.since),`
`172`	`172`	`reverse=True,`
`173`	`173`	`)`