Dependencies: Add compatibility with docutils 0.21

Author: amotl

CHANGES.md

@@ -1,6 +1,7 @@
 # Change Log
 
 ## Unreleased
+- Dependencies: Added compatibility with docutils 0.21
 
 ## v0.4.0 - 2024-06-27
 - Dependencies: Update to sphinx-design 0.6.0

pyproject.toml

@@ -82,6 +82,7 @@ dynamic = [
 ]
 dependencies = [
   "beautifulsoup4",
+  "docutils<0.22",
   "myst-parser",
   "sphinx<7.2",
   "sphinx-design==0.6.1",
@@ -93,7 +94,7 @@ optional-dependencies.develop = [
   "poethepoet<1",
   "pyproject-fmt<3",
   "ruff<0.15",
-  "types-docutils==0.20.0.3",
+  "types-docutils<0.22",
   "validate-pyproject<1",
 ]
 optional-dependencies.docs = [

sphinx_design_elements/gridtable.py

@@ -104,9 +104,10 @@ def run(self) -> List[nodes.Node]:
         self.state.nested_parse(self.content, self.content_offset, grid_row)
 
         # Apply widths.
-        widths = self.state_machine.document.attributes.get("widths")
+        widths = t.cast("t.Iterable[str]", self.state_machine.document.attributes.get("widths"))
         for column, width in zip(grid_row.children, widths):
-            column.update_basic_atts({"classes": item_columns_option(width)})
+            element = t.cast("nodes.Element", column)
+            element.update_basic_atts({"classes": item_columns_option(width)})
 
         return [grid_row]
 

sphinx_design_elements/hyper.py

@@ -141,8 +141,8 @@ def __call__(
 
         else:
             error = ValueError("Unable to resolve reference")
-            msg = inliner.reporter.warning(error)  # type: ignore[union-attr]
-            prb = inliner.problematic(rawtext, rawtext, msg)  # type: ignore[union-attr]
+            msg = inliner.reporter.warning(error)
+            prb = inliner.problematic(rawtext, rawtext, msg)
             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  # type: ignore[attr-defined]
+            document = self.inliner.document
             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  # type: ignore[attr-defined]
+            text=snippet, lineno=self.lineno, memo=self, parent=self.inliner.parent, with_container=self.with_container
         )
         if not directive_nodes:
             return [], self.system_messages

sphinx_design_elements/infocard.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Tuple
+from typing import List, Tuple, cast
 
 from docutils import nodes
 from docutils.statemachine import StringList
@@ -49,7 +49,7 @@ def create_grid(self) -> Tuple[nodes.container, nodes.container]:
         grid_container += grid_row
         return grid_container, grid_row
 
-    def create_card(self) -> Tuple[nodes.container, nodes.container]:
+    def create_card(self) -> Tuple[nodes.Element, nodes.Element]:
         """
         Create a sphinx-design "card" component.
 
@@ -74,7 +74,7 @@ def create_card(self) -> Tuple[nodes.container, nodes.container]:
 
         card_body = card_node.children[0]
         self.set_source_info(card_body)
-        return card_node, card_body
+        return cast("nodes.Element", card_node), cast("nodes.Element", card_body)
 
 
 class InfoCardDirective(GridBuilderDirective):
@@ -89,7 +89,6 @@ class InfoCardDirective(GridBuilderDirective):
     has_content = True
     required_arguments = 0
     optional_arguments = 1
-    option_spec: Dict[str, str] = {}
 
     def run(self) -> List[nodes.Node]:
         # Create a canvas grid.

sphinx_design_elements/shield.py

@@ -2,6 +2,7 @@
 
 from docutils import nodes
 from docutils.parsers.rst import directives
+from docutils.statemachine import StringList
 from myst_parser.mocking import MockState
 from sphinx.application import Sphinx
 from sphinx.util.docutils import SphinxDirective
@@ -62,7 +63,7 @@ def run(self):
         logo = self.options.get("logo")
         logo_color = self.options.get("logo-color")
         link = self.options.get("link")
-        link_title = self.options.get("link-title") or message  # TODO: Optionally add label?
+        link_title = self.options.get("link-title") or str(message)  # TODO: Optionally add label?
         link_alt = self.options.get("link-alt") or link_title
 
         # Sanity checks.
@@ -106,7 +107,7 @@ def parse_nested(self, content: str):
         When using MyST, parse reference within the same parsing context.
         """
         node_ = nodes.Element()
-        self.state.nested_parse(content.splitlines(), self.content_offset, node_)
+        self.state.nested_parse(StringList(content.splitlines()), self.content_offset, node_)
         return node_.children
 
 

sphinx_design_elements/tag.py

@@ -49,7 +49,7 @@ def run(self) -> t.Tuple[t.List[nodes.Node], t.List[nodes.system_message]]:
         """
         Run the role, rendering multiple "badge" nodes.
         """
-        elements = []
+        elements: t.List[nodes.Node] = []
 
         # Enumerate multiple items.
         for text in self.decode_input_text():
@@ -69,5 +69,4 @@ def run(self) -> t.Tuple[t.List[nodes.Node], t.List[nodes.system_message]]:
         # Remove last spacer again.
         if elements:
             elements.remove(elements[-1])
-
         return elements, []

sphinx_design_elements/util/role.py

@@ -102,7 +102,10 @@ def parse_block_myst(
         ref = container.next_node()
     else:
         ref = container.next_node().next_node()
-    return [ref], []
+    if ref:
+        return [ref], []
+    else:
+        return [], []
 
 
 def parse_block_rst(  # pragma: nocover