From 13d59bc1742279d7b1c614cd45c0499f5da104f4 Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Thu, 17 Jun 2021 15:03:34 -0500 Subject: [PATCH 1/2] Provide more semantic structure for screen-readers https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA12 --- sphinx/writers/html.py | 2 +- sphinx/writers/html5.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index d633f07e8e0..e9a31a848ca 100644 --- 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('') self.context.append('

\n') else: diff --git a/sphinx/writers/html5.py b/sphinx/writers/html5.py index 4696425910b..5b38b3be281 100644 --- 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('') self.context.append('

\n') else: From e6ae41ed52bb6c9d4f4b81dbe3417d532994f905 Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Mon, 21 Jun 2021 17:08:24 -0500 Subject: [PATCH 2/2] Include "role" attribute in expected HTML fragment --- tests/test_intl.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_intl.py b/tests/test_intl.py index 73d94166ea9..7791b4aeed5 100644 --- 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 = '' assert expected_expr in result - expected_expr = '

HIDDEN TOC

' + expected_expr = '

HIDDEN TOC

' assert expected_expr in result