From c8ef0fc94fd398fa1531ebf91467e16395c698cd Mon Sep 17 00:00:00 2001
From: Tobias Bengfort <bengfort@mpib-berlin.mpg.de>
Date: Tue, 23 Feb 2021 18:20:37 +0100
Subject: [PATCH] Fix aria label (#1056)

* Do not use the landmark role as part of the label

See https://www.w3.org/TR/wai-aria-practices/#general-principles-of-landmark-design

* translate aria-labels
---
 docs/_templates/layout.html       | 2 +-
 sphinx_rtd_theme/breadcrumbs.html | 4 ++--
 sphinx_rtd_theme/footer.html      | 2 +-
 sphinx_rtd_theme/layout.html      | 4 ++--
 sphinx_rtd_theme/versions.html    | 2 +-
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
index db88cb1c..08e1520d 100644
--- a/docs/_templates/layout.html
+++ b/docs/_templates/layout.html
@@ -10,7 +10,7 @@ Docs. This is for local testing purposes only.
 
 {% block footer %}
   {% if not READTHEDOCS %}
-    <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+    <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
       <span class="rst-current-version" data-toggle="rst-current-version">
         <span class="fa fa-book"> Read the Docs</span>
         v: latest
diff --git a/sphinx_rtd_theme/breadcrumbs.html b/sphinx_rtd_theme/breadcrumbs.html
index c27dcf4e..7d71c5d6 100644
--- a/sphinx_rtd_theme/breadcrumbs.html
+++ b/sphinx_rtd_theme/breadcrumbs.html
@@ -26,7 +26,7 @@
 
 {% set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %}
 
-<div role="navigation" aria-label="breadcrumbs navigation">
+<div role="navigation" aria-label="{{ _('Breadcrumbs') }}">
 
   <ul class="wy-breadcrumbs">
     {% block breadcrumbs %}
@@ -71,7 +71,7 @@
   </ul>
 
   {% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
-  <div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
+  <div class="rst-breadcrumbs-buttons" role="navigation" aria-label="{{ _('Breadcrumbs') }}">
       {% if prev %}
         <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
       {% endif %}
diff --git a/sphinx_rtd_theme/footer.html b/sphinx_rtd_theme/footer.html
index fd4b4f77..2be515c1 100644
--- a/sphinx_rtd_theme/footer.html
+++ b/sphinx_rtd_theme/footer.html
@@ -1,6 +1,6 @@
 <footer>
   {%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
-    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+    <div class="rst-footer-buttons" role="navigation" aria-label="{{ _('Footer') }}">
       {%- if prev %}
         <a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
       {%- endif %}
diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html
index ca16d166..ef69ac7d 100644
--- a/sphinx_rtd_theme/layout.html
+++ b/sphinx_rtd_theme/layout.html
@@ -153,7 +153,7 @@
         </div>
 
         {% block navigation %}
-        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Main') }}">
           {% block menu %}
             {#
               The singlehtml builder doesn't handle this toctree call when the
@@ -180,7 +180,7 @@
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 
       {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
-      <nav class="wy-nav-top" aria-label="top navigation">
+      <nav class="wy-nav-top" aria-label="{{ _('Top') }}">
         {% block mobile_nav %}
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="{{ pathto(master_doc) }}">{{ project }}</a>
diff --git a/sphinx_rtd_theme/versions.html b/sphinx_rtd_theme/versions.html
index 7368659c..bab969e6 100644
--- a/sphinx_rtd_theme/versions.html
+++ b/sphinx_rtd_theme/versions.html
@@ -1,6 +1,6 @@
 {% if READTHEDOCS %}
 {# Add rst-badge after rst-versions for small badge style. #}
-  <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+  <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
     <span class="rst-current-version" data-toggle="rst-current-version">
       <span class="fa fa-book"> Read the Docs</span>
       v: {{ current_version }}