Skip to content

Commit 0288b94

Browse files
q2markclaude
andcommitted
Replace <em> with <span> for desc_annotation semantic HTML
Replace <em class="property"> with <span class="property"> in HTML5 writer's visit_desc_annotation and depart_desc_annotation methods to improve semantic HTML structure for Python attribute type annotations. Fixes #13688 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent ca043c3 commit 0288b94

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

sphinx/writers/html5.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,10 +305,10 @@ def depart_desc_optional(self, node: Element) -> None:
305305
self.param_group_index += 1
306306

307307
def visit_desc_annotation(self, node: Element) -> None:
308-
self.body.append(self.starttag(node, 'em', '', CLASS='property'))
308+
self.body.append(self.starttag(node, 'span', '', CLASS='property'))
309309

310310
def depart_desc_annotation(self, node: Element) -> None:
311-
self.body.append('</em>')
311+
self.body.append('</span>')
312312

313313
##############################################
314314

tests/test_domains/test_domain_py_pyobject.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -925,17 +925,17 @@ def test_domain_py_type_alias(app):
925925

926926
content = (app.outdir / 'type_alias.html').read_text(encoding='utf8')
927927
assert (
928-
'<em class="property"><span class="k"><span class="pre">type</span></span><span class="w"> </span></em>'
928+
'<span class="property"><span class="k"><span class="pre">type</span></span><span class="w"> </span></span>'
929929
'<span class="sig-prename descclassname"><span class="pre">module_one.</span></span>'
930930
'<span class="sig-name descname"><span class="pre">MyAlias</span></span>'
931-
'<em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span>'
931+
'<span class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span>'
932932
'<span class="w"> </span><span class="pre">list</span>'
933933
'<span class="p"><span class="pre">[</span></span>'
934934
'<span class="pre">int</span><span class="w"> </span>'
935935
'<span class="p"><span class="pre">|</span></span><span class="w"> </span>'
936936
'<a class="reference internal" href="#module_two.SomeClass" title="module_two.SomeClass">'
937937
'<span class="pre">module_two.SomeClass</span></a>'
938-
'<span class="p"><span class="pre">]</span></span></em>'
938+
'<span class="p"><span class="pre">]</span></span></span>'
939939
) in content
940940
assert app.warning.getvalue() == ''
941941

0 commit comments

Comments
 (0)