🐛 FIX: Fix ValueError in tab-set with invalid children (#243)

Co-authored-by: chrisjsewell <2997570+chrisjsewell@users.noreply.github.com>

Author: Copilot

sphinx_design/tabs.py

@@ -35,6 +35,7 @@ def run_with_defaults(self) -> list[nodes.Node]:
         )
         self.set_source_info(tab_set)
         self.state.nested_parse(self.content, self.content_offset, tab_set)
+        valid_children = []
         for item in tab_set.children:
             if not is_component(item, "tab-item"):
                 LOGGER.warning(
@@ -44,9 +45,12 @@ def run_with_defaults(self) -> list[nodes.Node]:
                     type=WARNING_TYPE,
                     subtype="tab",
                 )
-                break
+                continue  # Skip invalid children instead of breaking
             if "sync_id" in item.children[0]:
                 item.children[0]["sync_group"] = self.options.get("sync-group", "tab")
+            valid_children.append(item)
+
+        tab_set.children = valid_children
         return [tab_set]
 
 
@@ -240,10 +244,17 @@ def run(self) -> None:
             selected_idx = 0 if selected_idx is None else selected_idx
 
             for idx, tab_item in enumerate(tab_set.children):
-                try:
-                    tab_label, tab_content = tab_item.children
-                except ValueError:
-                    raise
+                if not is_component(tab_item, "tab-item"):
+                    continue  # Skip non tab-item children
+                if len(tab_item.children) != 2:
+                    LOGGER.warning(
+                        f"Malformed 'tab-item' directive [{WARNING_TYPE}.tab]",
+                        location=tab_item,
+                        type=WARNING_TYPE,
+                        subtype="tab",
+                    )
+                    continue
+                tab_label, tab_content = tab_item.children
                 tab_item_identity = tab_item_id_base + str(tab_item_id_num)
                 tab_item_id_num += 1
 

tests/test_misc.py

@@ -30,3 +30,43 @@ def test_material(style, file_regression):
     for name in sorted(data):
         content += f"{name}: {','.join(data[name]['heights'])}\n"
     file_regression.check(content)
+
+
+def test_tab_set_with_invalid_children(sphinx_builder, file_regression, normalize_doctree_xml):
+    """Test that tab-set with invalid children does not crash.
+    
+    This reproduces the issue from https://github.com/executablebooks/sphinx-design/issues/243
+    where a ValueError was raised when a tab-set contained non-tab-item children.
+    """
+    builder = sphinx_builder(conf_kwargs={"extensions": ["sphinx_design"]})
+    builder.src_path.joinpath("index.rst").write_text(
+        """
+Tab Test document
+=================
+
+.. tab-set::
+
+   .. tab-item:: A
+
+      A content
+
+   foo
+
+   .. tab-item:: B
+
+      B content
+""",
+        encoding="utf8",
+    )
+    # Build should not crash, but should produce a warning
+    builder.build(assert_pass=False)
+    assert "All children of a 'tab-set' should be 'tab-item'" in builder.warnings
+    
+    # Valid tab items should still be processed
+    doctree = builder.get_doctree("index", post_transforms=True)
+    doctree.attributes.pop("translation_progress", None)
+    file_regression.check(
+        normalize_doctree_xml(doctree.pformat()),
+        extension=".xml",
+        encoding="utf8",
+    )

tests/test_misc/test_tab_set_with_invalid_children.xml

@@ -0,0 +1,17 @@
+<document source="index">
+    <section ids="tab-test-document" names="tab\ test\ document">
+        <title>
+            Tab Test document
+        <container classes="sd-tab-set" design_component="tab-set" is_div="True">
+            <sd_tab_input checked="True" id="sd-tab-item-0" set_id="sd-tab-set-0" type="radio">
+            <sd_tab_label classes="sd-tab-label" input_id="sd-tab-item-0">
+                A
+            <container classes="sd-tab-content" design_component="tab-content" is_div="True">
+                <paragraph>
+                    A content
+            <sd_tab_input checked="False" id="sd-tab-item-1" set_id="sd-tab-set-0" type="radio">
+            <sd_tab_label classes="sd-tab-label" input_id="sd-tab-item-1">
+                B
+            <container classes="sd-tab-content" design_component="tab-content" is_div="True">
+                <paragraph>
+                    B content