diff --git a/AUTHORS.rst b/AUTHORS.rst index d08f44875b4..11e0206f7ca 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -83,6 +83,7 @@ Contributors * Louis Maddox -- better docstrings * Łukasz Langa -- partial support for autodoc * Marco Buttu -- doctest extension (pyversion option) +* Mark Ostroth -- semantic HTML contributions * Martin Hans -- autodoc improvements * Martin Larralde -- additional napoleon admonitions * Martin Liška -- option directive and role improvements diff --git a/CHANGES.rst b/CHANGES.rst index 791038e5e15..7f405121bc3 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -97,6 +97,11 @@ Bugs fixed Patch by Bénédikt Tran. * #13712: intersphinx: Don't add "v" prefix to non-numeric versions. Patch by Szymon Karpinski. +* #13688: HTML builder: Replace ```` with + ```` for attribute type annotations + to improve `semantic HTML structure + `__. + Patch by Mark Ostroth. Testing ------- diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index 39d7ecea680..bbcd247e33c 100644 --- a/sphinx/writers/html5.py +++ b/sphinx/writers/html5.py @@ -305,10 +305,10 @@ def depart_desc_optional(self, node: Element) -> None: self.param_group_index += 1 def visit_desc_annotation(self, node: Element) -> None: - self.body.append(self.starttag(node, 'em', '', CLASS='property')) + self.body.append(self.starttag(node, 'span', '', CLASS='property')) def depart_desc_annotation(self, node: Element) -> None: - self.body.append('') + self.body.append('') ############################################## diff --git a/tests/test_domains/test_domain_py_pyobject.py b/tests/test_domains/test_domain_py_pyobject.py index 12b22a04dcc..dec4d71546e 100644 --- a/tests/test_domains/test_domain_py_pyobject.py +++ b/tests/test_domains/test_domain_py_pyobject.py @@ -925,17 +925,17 @@ def test_domain_py_type_alias(app): content = (app.outdir / 'type_alias.html').read_text(encoding='utf8') assert ( - 'type ' + 'type ' 'module_one.' 'MyAlias' - ' =' + ' =' ' list' '[' 'int ' '| ' '' 'module_two.SomeClass' - ']' + ']' ) in content assert app.warning.getvalue() == ''