Fix ValueError crash when tab-set contains non-tab-item children#258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrisjsewell merged 4 commits into from
Jan 19, 2026
Merged

Fix ValueError crash when tab-set contains non-tab-item children #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b22c820
Initial plan
Copilot Jan 19, 2026
9d45201
🐛 FIX: Fix ValueError in tab-set with invalid children (#243)
Copilot Jan 19, 2026
3654e94
🔧 MAINTAIN: Fix pre-commit formatting issues
Copilot Jan 19, 2026
dc88a05
Merge branch 'main' into copilot/fix-valueerror-in-tabset-directive
chrisjsewell Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions sphinx_design/tabs.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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(
Expand All@@ -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]


Expand DownExpand Up@@ -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

Expand Down
42 changes: 42 additions & 0 deletions tests/test_misc.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,3 +30,45 @@ 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",
)
17 changes: 17 additions & 0 deletions tests/test_misc/test_tab_set_with_invalid_children.xml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Fix ValueError crash when tab-set contains non-tab-item children#258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chrisjsewell
merged 4 commits into

from

Jan 19, 2026
 Merged


Fix ValueError crash when tab-set contains non-tab-item children
#258
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b22c820

Initial plan


Copilot Jan 19, 2026
9d45201

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


Copilot Jan 19, 2026
3654e94

🔧 MAINTAIN: Fix pre-commit formatting issues


Copilot Jan 19, 2026
dc88a05

Merge branch 'main' into copilot/fix-valueerror-in-tabset-directive


chrisjsewell Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 16 additions & 5 deletions
sphinx_design/tabs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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(
Expand All@@ -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]


Expand DownExpand Up@@ -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

Expand Down

42 changes: 42 additions & 0 deletions
tests/test_misc.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,3 +30,45 @@ 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",
 )

17 changes: 17 additions & 0 deletions
tests/test_misc/test_tab_set_with_invalid_children.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix ValueError crash when tab-set contains non-tab-item children#258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chrisjsewell
merged 4 commits into

from

Jan 19, 2026
 Merged


Fix ValueError crash when tab-set contains non-tab-item children
#258
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b22c820

Initial plan


Copilot Jan 19, 2026
9d45201

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


Copilot Jan 19, 2026
3654e94

🔧 MAINTAIN: Fix pre-commit formatting issues


Copilot Jan 19, 2026
dc88a05

Merge branch 'main' into copilot/fix-valueerror-in-tabset-directive


chrisjsewell Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 16 additions & 5 deletions
sphinx_design/tabs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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(
Expand All@@ -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]


Expand DownExpand Up@@ -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

Expand Down

42 changes: 42 additions & 0 deletions
tests/test_misc.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,3 +30,45 @@ 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",
 )

17 changes: 17 additions & 0 deletions
tests/test_misc/test_tab_set_with_invalid_children.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix ValueError crash when tab-set contains non-tab-item children#258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chrisjsewell
merged 4 commits into

from

Jan 19, 2026
 Merged


Fix ValueError crash when tab-set contains non-tab-item children
#258
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b22c820

Initial plan


Copilot Jan 19, 2026
9d45201

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


Copilot Jan 19, 2026
3654e94

🔧 MAINTAIN: Fix pre-commit formatting issues


Copilot Jan 19, 2026
dc88a05

Merge branch 'main' into copilot/fix-valueerror-in-tabset-directive


chrisjsewell Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 16 additions & 5 deletions
sphinx_design/tabs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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(
Expand All@@ -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]


Expand DownExpand Up@@ -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

Expand Down

42 changes: 42 additions & 0 deletions
tests/test_misc.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,3 +30,45 @@ 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",
 )

17 changes: 17 additions & 0 deletions
tests/test_misc/test_tab_set_with_invalid_children.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Fix ValueError crash when tab-set contains non-tab-item children#258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chrisjsewell
merged 4 commits into

from

Jan 19, 2026
 Merged


Fix ValueError crash when tab-set contains non-tab-item children
#258
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b22c820

Initial plan


Copilot Jan 19, 2026
9d45201

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


Copilot Jan 19, 2026
3654e94

🔧 MAINTAIN: Fix pre-commit formatting issues


Copilot Jan 19, 2026
dc88a05

Merge branch 'main' into copilot/fix-valueerror-in-tabset-directive


chrisjsewell Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 16 additions & 5 deletions
sphinx_design/tabs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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(
Expand All@@ -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]


Expand DownExpand Up@@ -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

Expand Down

42 changes: 42 additions & 0 deletions
tests/test_misc.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,3 +30,45 @@ 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",
 )

17 changes: 17 additions & 0 deletions
tests/test_misc/test_tab_set_with_invalid_children.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix ValueError crash when tab-set contains non-tab-item children#258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chrisjsewell
merged 4 commits into

from

Jan 19, 2026
 Merged


Fix ValueError crash when tab-set contains non-tab-item children
#258
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b22c820

Initial plan


Copilot Jan 19, 2026
9d45201

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


Copilot Jan 19, 2026
3654e94

🔧 MAINTAIN: Fix pre-commit formatting issues


Copilot Jan 19, 2026
dc88a05

Merge branch 'main' into copilot/fix-valueerror-in-tabset-directive


chrisjsewell Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 16 additions & 5 deletions
sphinx_design/tabs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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(
Expand All@@ -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]


Expand DownExpand Up@@ -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

Expand Down

42 changes: 42 additions & 0 deletions
tests/test_misc.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,3 +30,45 @@ 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",
 )

17 changes: 17 additions & 0 deletions
tests/test_misc/test_tab_set_with_invalid_children.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Fix ValueError crash when tab-set contains non-tab-item children#258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chrisjsewell
merged 4 commits into

from

Jan 19, 2026
 Merged


Fix ValueError crash when tab-set contains non-tab-item children
#258
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b22c820

Initial plan


Copilot Jan 19, 2026
9d45201

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


Copilot Jan 19, 2026
3654e94

🔧 MAINTAIN: Fix pre-commit formatting issues


Copilot Jan 19, 2026
dc88a05

Merge branch 'main' into copilot/fix-valueerror-in-tabset-directive


chrisjsewell Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 16 additions & 5 deletions
sphinx_design/tabs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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(
Expand All@@ -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]


Expand DownExpand Up@@ -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

Expand Down

42 changes: 42 additions & 0 deletions
tests/test_misc.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,3 +30,45 @@ 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",
 )

17 changes: 17 additions & 0 deletions
tests/test_misc/test_tab_set_with_invalid_children.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Fix ValueError crash when tab-set contains non-tab-item children#258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

chrisjsewell
merged 4 commits into

from

Jan 19, 2026
 Merged


Fix ValueError crash when tab-set contains non-tab-item children
#258
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
b22c820

Initial plan


Copilot Jan 19, 2026
9d45201

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


Copilot Jan 19, 2026
3654e94

🔧 MAINTAIN: Fix pre-commit formatting issues


Copilot Jan 19, 2026
dc88a05

Merge branch 'main' into copilot/fix-valueerror-in-tabset-directive


chrisjsewell Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


21 changes: 16 additions & 5 deletions
sphinx_design/tabs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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(
Expand All@@ -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]


Expand DownExpand Up@@ -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

Expand Down

42 changes: 42 additions & 0 deletions
tests/test_misc.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,3 +30,45 @@ 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",
 )

17 changes: 17 additions & 0 deletions
tests/test_misc/test_tab_set_with_invalid_children.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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