refactor: Use dataclasses for configuration/options and automate schema generation

Author: pawamoy

config/pytest.ini

@@ -10,6 +10,7 @@ testpaths =
 # action:message_regex:warning_class:module_regex:line
 filterwarnings =
   error
-  # TODO: remove once pytest-xdist 4 is released
+  # TODO: Remove once pytest-xdist 4 is released.
   ignore:.*rsyncdir:DeprecationWarning:xdist
+  # TODO: Remove once mkdocstrings stops setting fallback function.
   ignore:.*fallback anchor function:DeprecationWarning:mkdocstrings

docs/schema.json

@@ -199,13 +199,6 @@ in the following pages:
 - [Docstrings options](configuration/docstrings.md): options related to docstrings (parsing and rendering)
 - [Signature options](configuration/signatures.md): options related to signatures and type annotations
 
-#### Options summary
-
-::: mkdocstrings_handlers.python.handler.PythonHandler.default_config
-    options:
-      show_root_heading: false
-      show_root_toc_entry: false
-
 ## Finding modules
 
 There are multiple ways to tell the handler where to find your packages/modules.

docs/usage/index.md

@@ -88,6 +88,8 @@ def check_types(ctx: Context) -> None:
     ctx.run(
         tools.mypy(*PY_SRC_LIST, config_file="config/mypy.ini"),
         title=pyprefix("Type-checking"),
+        # TODO: Update when Pydantic supports 3.14.
+        nofail=sys.version_info >= (3, 14),
     )
 
 

duties.py

@@ -13,6 +13,9 @@ validation:
   absolute_links: warn
   unrecognized_links: warn
 
+hooks:
+- scripts/mkdocs_hooks.py
+
 nav:
 - Home:
   - Overview: index.md
@@ -160,6 +163,8 @@ plugins:
           docstring_options:
             ignore_init_summary: true
           docstring_section_style: list
+          extensions:
+          - scripts/griffe_extensions.py
           filters: ["!^_"]
           heading_level: 1
           inherited_members: true

mkdocs.yml

@@ -30,9 +30,10 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "mkdocstrings>=0.26",
+    "mkdocstrings>=0.28",
     "mkdocs-autorefs>=1.2",
     "griffe>=0.49",
+    "typing-extensions>=4.0; python_version < '3.11'",
 ]
 
 [project.urls]
@@ -106,10 +107,12 @@ dev = [
     "mkdocs-git-revision-date-localized-plugin>=1.2",
     "mkdocs-literate-nav>=0.6",
     "mkdocs-material>=9.5",
+    "pydantic>=2.10",
     "mkdocs-minify-plugin>=0.8",
     # YORE: EOL 3.10: Remove line.
     "tomli>=2.0; python_version < '3.11'",
 ]
 
 [tool.inline-snapshot]
 storage-dir = "tests/snapshots"
+format-command = "ruff format --config config/ruff.toml --stdin-filename {filename}"