Provide more semantic structure for screen-readers

https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA12
sphinx-doc · Jun 17, 2021 · 13d59bc · 13d59bc
1 parent e0b1e10
commit 13d59bc
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 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: