LinkTree: Fix type hinting

Author: amotl

.github/workflows/main.yml

@@ -102,6 +102,7 @@ jobs:
         # Install specific Sphinx and docutils versions, according to test matrix slots.
         uv pip install 'sphinx==${{ matrix.sphinx-version }}'
         uv pip install 'docutils==${{ matrix.docutils-version }}'
+        uv pip install 'types-docutils==${{ matrix.docutils-version }}'
 
     - name: Sphinx and docutils versions
       run: |

sphinx_design_elements/hyper.py

@@ -5,7 +5,7 @@
 
 import yaml
 from docutils import nodes
-from docutils.nodes import Node, system_message, unescape
+from docutils.nodes import Node, system_message, unescape  # type: ignore[attr-defined]
 from docutils.parsers.rst.states import Inliner
 from myst_parser.mocking import MockInliner
 from sphinx.application import Sphinx
@@ -141,8 +141,8 @@ def __call__(
 
         else:
             error = ValueError("Unable to resolve reference")
-            msg = inliner.reporter.warning(error)
-            prb = inliner.problematic(rawtext, rawtext, msg)
+            msg = inliner.reporter.warning(error)  # type: ignore[union-attr]
+            prb = inliner.problematic(rawtext, rawtext, msg)  # type: ignore[union-attr]
             return [prb], [msg]
 
         return SphinxRole.__call__(self, name, rawtext, text, lineno, inliner, options, content)  # type: ignore[arg-type]
@@ -158,7 +158,7 @@ def resolve_page_title(self) -> str:
             except Exception:
                 return self.target
         elif self.srh.is_traditional_intersphinx_reference():
-            document = self.inliner.document
+            document = self.inliner.document  # type: ignore[attr-defined]
             ref = resolve_reference(env=self.app.env, document=document, target=self.target)
         elif self.srh.is_myst_reference():
             link = f"[]({self.target})"
@@ -308,7 +308,7 @@ def render_snippet(self, snippet: str) -> Tuple[List[nodes.Node], List[nodes.sys
         Render a MyST snippet.
         """
         directive_nodes, _ = self.inliner.parse_block(  # type: ignore[attr-defined]
-            text=snippet, lineno=self.lineno, memo=self, parent=self.inliner.parent, with_container=self.with_container
+            text=snippet, lineno=self.lineno, memo=self, parent=self.inliner.parent, with_container=self.with_container  # type: ignore[attr-defined]
         )
         if not directive_nodes:
             return [], self.system_messages

sphinx_design_elements/linktree.py

@@ -1,3 +1,4 @@
+import sys
 import traceback
 from typing import List
 
@@ -62,7 +63,7 @@ def run(self) -> List[nodes.Node]:
                 f"The 'linktree' directive currently does not accept content. "
                 f"The offending node is:\n{self.block_text}"
             )
-            self.reporter.severe(message)
+            self.reporter.severe(message)  # type: ignore[attr-defined]
             raise SphinxError(message)
 
         # Create a surrogate node element.
@@ -125,7 +126,8 @@ def produce(self, node: nodes.Element, docname: str) -> nodes.Element:
         try:
             project.toctree(maxdepth=int(node.get("maxdepth", -1)))
         except Exception as ex:
-            tb = "".join(traceback.format_exception(ex))
+            exc_type, exc_value, exc_tb = sys.exc_info()
+            tb = "".join(traceback.format_exception(exc_type, exc_value, exc_tb))
             message = (
                 f"Error producing a toc tree for document using the 'linktree' directive: {docname}. "
                 f"The offending node is:\n{node}\nThe exception was:\n{tb}"

sphinx_design_elements/util/role.py

@@ -107,7 +107,7 @@ def parse_block_myst(
     if with_container:
         ref = container.next_node()
     else:
-        ref = cast("nodes.Node", container.next_node()).next_node()
+        ref = cast("nodes.Node", container.next_node()).next_node()  # type: ignore[redundant-cast]
     if ref:
         return [ref], []
     else: