From 5e5a3bf039043300b7a5526e41c37aff652db653 Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Date: Sun, 29 Dec 2024 00:31:55 +0000
Subject: [PATCH] Enable automatic formatting for ``sphinx/domains/``

---
 .ruff.toml                 |  1 -
 sphinx/domains/__init__.py | 60 ++++++++++++++++++++++++++------------
 2 files changed, 42 insertions(+), 19 deletions(-)

diff --git a/.ruff.toml b/.ruff.toml
index 53a9fae34..b1cd1334b 100644
--- a/.ruff.toml
+++ b/.ruff.toml
@@ -394,7 +394,6 @@ preview = true
 quote-style = "single"
 exclude = [
     "sphinx/builders/latex/constants.py",
-    "sphinx/domains/__init__.py",
     "sphinx/domains/c/_parser.py",
     "sphinx/domains/c/_ids.py",
     "sphinx/domains/c/__init__.py",
diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py
index 3f21078c6..4064b7eaf 100644
--- a/sphinx/domains/__init__.py
+++ b/sphinx/domains/__init__.py
@@ -141,7 +141,7 @@ class Domain:
         std = self.env.domains.standard_domain
         for index in self.indices:
             if index.name and index.localname:
-                docname = f"{self.name}-{index.name}"
+                docname = f'{self.name}-{index.name}'
                 std.note_hyperlink_target(docname, docname, '', index.localname)
 
     def add_object_type(self, name: str, objtype: ObjType) -> None:
@@ -165,12 +165,19 @@ class Domain:
             return None
         fullname = f'{self.name}:{name}'
 
-        def role_adapter(typ: str, rawtext: str, text: str, lineno: int,
-                         inliner: Inliner, options: dict | None = None,
-                         content: Sequence[str] = (),
-                         ) -> tuple[list[Node], list[nodes.system_message]]:
-            return self.roles[name](fullname, rawtext, text, lineno,
-                                    inliner, options or {}, content)
+        def role_adapter(
+            typ: str,
+            rawtext: str,
+            text: str,
+            lineno: int,
+            inliner: Inliner,
+            options: dict | None = None,
+            content: Sequence[str] = (),
+        ) -> tuple[list[Node], list[nodes.system_message]]:
+            return self.roles[name](
+                fullname, rawtext, text, lineno, inliner, options or {}, content
+            )
+
         self._role_cache[name] = role_adapter
         return role_adapter
 
@@ -189,6 +196,7 @@ class Domain:
             def run(self) -> list[Node]:
                 self.name = fullname
                 return super().run()
+
         self._directive_cache[name] = DirectiveAdapter
         return DirectiveAdapter
 
@@ -202,12 +210,15 @@ class Domain:
         """Merge in data regarding *docnames* from a different domaindata
         inventory (coming from a subprocess in parallel builds).
         """
-        raise NotImplementedError('merge_domaindata must be implemented in %s '
-                                  'to be able to do parallel builds!' %
-                                  self.__class__)
+        msg = (
+            f'merge_domaindata must be implemented in {self.__class__} '
+            'to be able to do parallel builds!'
+        )
+        raise NotImplementedError(msg)
 
-    def process_doc(self, env: BuildEnvironment, docname: str,
-                    document: nodes.document) -> None:
+    def process_doc(
+        self, env: BuildEnvironment, docname: str, document: nodes.document
+    ) -> None:
         """Process a document after it is read by the environment."""
         pass
 
@@ -221,9 +232,16 @@ class Domain:
         """
         pass
 
-    def resolve_xref(self, env: BuildEnvironment, fromdocname: str, builder: Builder,
-                     typ: str, target: str, node: pending_xref, contnode: Element,
-                     ) -> nodes.reference | None:
+    def resolve_xref(
+        self,
+        env: BuildEnvironment,
+        fromdocname: str,
+        builder: Builder,
+        typ: str,
+        target: str,
+        node: pending_xref,
+        contnode: Element,
+    ) -> nodes.reference | None:
         """Resolve the pending_xref *node* with the given *typ* and *target*.
 
         This method should return a new node, to replace the xref node,
@@ -239,9 +257,15 @@ class Domain:
         """
         pass
 
-    def resolve_any_xref(self, env: BuildEnvironment, fromdocname: str, builder: Builder,
-                         target: str, node: pending_xref, contnode: Element,
-                         ) -> list[tuple[str, nodes.reference]]:
+    def resolve_any_xref(
+        self,
+        env: BuildEnvironment,
+        fromdocname: str,
+        builder: Builder,
+        target: str,
+        node: pending_xref,
+        contnode: Element,
+    ) -> list[tuple[str, nodes.reference]]:
         """Resolve the pending_xref *node* with the given *target*.
 
         The reference comes from an "any" or similar role, which means that we