Sphinx 8.1.2__py3-none-any.whl → 8.2.0__py3-none-any.whl

sphinx/domains/changeset.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, ClassVar, NamedTuple
+from typing import TYPE_CHECKING, NamedTuple
 
 from docutils import nodes
 
@@ -13,6 +13,7 @@ from sphinx.util.docutils import SphinxDirective
 
 if TYPE_CHECKING:
     from collections.abc import Set
+    from typing import Any, ClassVar
 
     from docutils.nodes import Node
 
@@ -22,17 +23,17 @@ if TYPE_CHECKING:
 
 
 versionlabels = {
-    'versionadded':   _('Added in version %s'),
+    'versionadded': _('Added in version %s'),
     'versionchanged': _('Changed in version %s'),
-    'deprecated':     _('Deprecated since version %s'),
+    'deprecated': _('Deprecated since version %s'),
     'versionremoved': _('Removed in version %s'),
 }
 
 versionlabel_classes = {
-    'versionadded':     'added',
-    'versionchanged':   'changed',
-    'deprecated':       'deprecated',
-    'versionremoved':   'removed',
+    'versionadded': 'added',
+    'versionchanged': 'changed',
+    'deprecated': 'deprecated',
+    'versionremoved': 'removed',
 }
 
 
@@ -41,14 +42,12 @@ class ChangeSet(NamedTuple):
     docname: str
     lineno: int
     module: str | None
-    descname: str | None
+    descname: str
     content: str
 
 
 class VersionChange(SphinxDirective):
-    """
-    Directive to describe a change/addition/deprecation in a specific version.
-    """
+    """Directive to describe a change/addition/deprecation in a specific version."""
 
     has_content = True
     required_arguments = 1
@@ -64,7 +63,9 @@ class VersionChange(SphinxDirective):
         node['version'] = self.arguments[0]
         text = versionlabels[self.name] % self.arguments[0]
         if len(self.arguments) == 2:
-            inodes, messages = self.parse_inline(self.arguments[1], lineno=self.lineno + 1)
+            inodes, messages = self.parse_inline(
+                self.arguments[1], lineno=self.lineno + 1
+            )
             para = nodes.paragraph(self.arguments[1], '', *inodes, translatable=False)
             self.set_source_info(para)
             node.append(para)
@@ -81,21 +82,29 @@ class VersionChange(SphinxDirective):
                 content.source = node[0].source
                 content.line = node[0].line
                 content += node[0].children
-                node[0].replace_self(nodes.paragraph('', '', content, translatable=False))
+                node[0].replace_self(
+                    nodes.paragraph('', '', content, translatable=False)
+                )
 
             para = node[0]
             para.insert(0, nodes.inline('', '%s: ' % text, classes=classes))
         elif len(node) > 0:
             # the contents do not starts with a paragraph
-            para = nodes.paragraph('', '',
-                                   nodes.inline('', '%s: ' % text, classes=classes),
-                                   translatable=False)
+            para = nodes.paragraph(
+                '',
+                '',
+                nodes.inline('', '%s: ' % text, classes=classes),
+                translatable=False,
+            )
             node.insert(0, para)
         else:
             # the contents are empty
-            para = nodes.paragraph('', '',
-                                   nodes.inline('', '%s.' % text, classes=classes),
-                                   translatable=False)
+            para = nodes.paragraph(
+                '',
+                '',
+                nodes.inline('', '%s.' % text, classes=classes),
+                translatable=False,
+            )
             node.append(para)
 
         domain = self.env.domains.changeset_domain
@@ -113,7 +122,7 @@ class ChangeSetDomain(Domain):
     label = 'changeset'
 
     initial_data: dict[str, dict[str, list[ChangeSet]]] = {
-        'changes': {},      # version -> list of ChangeSet
+        'changes': {},  # version -> list of ChangeSet
     }
 
     @property
@@ -123,9 +132,15 @@ class ChangeSetDomain(Domain):
     def note_changeset(self, node: addnodes.versionmodified) -> None:
         version = node['version']
         module = self.env.ref_context.get('py:module')
-        objname = self.env.temp_data.get('object')
-        changeset = ChangeSet(node['type'], self.env.docname, node.line,  # type: ignore[arg-type]
-                              module, objname, node.astext())
+        objname = self.env.current_document.obj_desc_name
+        changeset = ChangeSet(
+            node['type'],
+            self.env.docname,
+            node.line,  # type: ignore[arg-type]
+            module,
+            objname,
+            node.astext(),
+        )
         self.changesets.setdefault(version, []).append(changeset)
 
     def clear_doc(self, docname: str) -> None:
@@ -143,7 +158,7 @@ class ChangeSetDomain(Domain):
                     changes.append(changeset)
 
     def process_doc(
-        self, env: BuildEnvironment, docname: str, document: nodes.document,
+        self, env: BuildEnvironment, docname: str, document: nodes.document
     ) -> None:
         pass  # nothing to do here. All changesets are registered on calling directive.
 

sphinx/domains/citation.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, cast
+from typing import TYPE_CHECKING, cast
 
 from docutils import nodes
 
@@ -15,6 +15,7 @@ from sphinx.util.nodes import copy_source_info, make_refnode
 
 if TYPE_CHECKING:
     from collections.abc import Set
+    from typing import Any
 
     from docutils.nodes import Element
 
@@ -70,8 +71,14 @@ class CitationDomain(Domain):
         label = node[0].astext()
         if label in self.citations:
             path = self.env.doc2path(self.citations[label][0])
-            logger.warning(__('duplicate citation %s, other instance in %s'), label, path,
-                           location=node, type='ref', subtype='citation')
+            logger.warning(
+                __('duplicate citation %s, other instance in %s'),
+                label,
+                path,
+                location=node,
+                type='ref',
+                subtype='citation',
+            )
         self.citations[label] = (node['docname'], node['ids'][0], node.line)  # type: ignore[assignment]
 
     def note_citation_reference(self, node: pending_xref) -> None:
@@ -81,23 +88,42 @@ class CitationDomain(Domain):
     def check_consistency(self) -> None:
         for name, (docname, _labelid, lineno) in self.citations.items():
             if name not in self.citation_refs:
-                logger.warning(__('Citation [%s] is not referenced.'), name,
-                               type='ref', subtype='citation', location=(docname, lineno))
-
-    def resolve_xref(self, env: BuildEnvironment, fromdocname: str, builder: Builder,
-                     typ: str, target: str, node: pending_xref, contnode: Element,
-                     ) -> Element | None:
+                logger.warning(
+                    __('Citation [%s] is not referenced.'),
+                    name,
+                    type='ref',
+                    subtype='citation',
+                    location=(docname, lineno),
+                )
+
+    def resolve_xref(
+        self,
+        env: BuildEnvironment,
+        fromdocname: str,
+        builder: Builder,
+        typ: str,
+        target: str,
+        node: pending_xref,
+        contnode: Element,
+    ) -> nodes.reference | None:
         docname, labelid, lineno = self.citations.get(target, ('', '', 0))
         if not docname:
             return None
 
-        return make_refnode(builder, fromdocname, docname,
-                            labelid, contnode)
-
-    def resolve_any_xref(self, env: BuildEnvironment, fromdocname: str, builder: Builder,
-                         target: str, node: pending_xref, contnode: Element,
-                         ) -> list[tuple[str, Element]]:
-        refnode = self.resolve_xref(env, fromdocname, builder, 'ref', target, node, contnode)
+        return make_refnode(builder, fromdocname, docname, labelid, contnode)
+
+    def resolve_any_xref(
+        self,
+        env: BuildEnvironment,
+        fromdocname: str,
+        builder: Builder,
+        target: str,
+        node: pending_xref,
+        contnode: Element,
+    ) -> list[tuple[str, nodes.reference]]:
+        refnode = self.resolve_xref(
+            env, fromdocname, builder, 'ref', target, node, contnode
+        )
         if refnode is None:
             return []
         else:
@@ -117,13 +143,12 @@ class CitationDefinitionTransform(SphinxTransform):
             domain.note_citation(node)
 
             # mark citation labels as not smartquoted
-            label = cast(nodes.label, node[0])
+            label = cast('nodes.label', node[0])
             label['support_smartquotes'] = False
 
 
 class CitationReferenceTransform(SphinxTransform):
-    """
-    Replace citation references by pending_xref nodes before the default
+    """Replace citation references by pending_xref nodes before the default
     docutils transform tries to resolve them.
     """
 
@@ -133,11 +158,16 @@ class CitationReferenceTransform(SphinxTransform):
         domain = self.env.domains.citation_domain
         for node in self.document.findall(nodes.citation_reference):
             target = node.astext()
-            ref = pending_xref(target, refdomain='citation', reftype='ref',
-                               reftarget=target, refwarn=True,
-                               support_smartquotes=False,
-                               ids=node["ids"],
-                               classes=node.get('classes', []))
+            ref = pending_xref(
+                target,
+                refdomain='citation',
+                reftype='ref',
+                reftarget=target,
+                refwarn=True,
+                support_smartquotes=False,
+                ids=node['ids'],
+                classes=node.get('classes', []),
+            )
             ref += nodes.inline(target, '[%s]' % target)
             copy_source_info(node, ref)
             node.replace_self(ref)