Merge pull request #9358 from jonels-msft/menu-headings

Provide more semantic structure for screen-readers
sphinx-doc · Jul 6, 2021 · 7bd4603 · 7bd4603
2 parents 5ce5f40 + e6ae41e
commit 7bd4603
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py
@@ -415,7 +415,7 @@ def depart_term(self, node: Element) -> None:
     # overwritten
     def visit_title(self, node: Element) -> None:
         if isinstance(node.parent, addnodes.compact_paragraph) and node.parent.get('toctree'):
-            self.body.append(self.starttag(node, 'p', '', CLASS='caption'))
+            self.body.append(self.starttag(node, 'p', '', CLASS='caption', ROLE='heading'))
             self.body.append('<span class="caption-text">')
             self.context.append('</span></p>\n')
         else:

diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py
@@ -366,7 +366,7 @@ def depart_term(self, node: Element) -> None:
     # overwritten
     def visit_title(self, node: Element) -> None:
         if isinstance(node.parent, addnodes.compact_paragraph) and node.parent.get('toctree'):
-            self.body.append(self.starttag(node, 'p', '', CLASS='caption'))
+            self.body.append(self.starttag(node, 'p', '', CLASS='caption', ROLE='heading'))
             self.body.append('<span class="caption-text">')
             self.context.append('</span></p>\n')
         else:

diff --git a/tests/test_intl.py b/tests/test_intl.py
@@ -622,7 +622,7 @@ def test_html_meta(app):
     assert expected_expr in result
     expected_expr = '<meta content="I18N, SPHINX, MARKUP" name="keywords" />'
     assert expected_expr in result
-    expected_expr = '<p class="caption"><span class="caption-text">HIDDEN TOC</span></p>'
+    expected_expr = '<p class="caption" role="heading"><span class="caption-text">HIDDEN TOC</span></p>'
     assert expected_expr in result