readthedocs/sphinx_rtd_theme

Duplicated access key of the prev and next buttons when prev_next_buttons_location == 'both'

Open

#1,057 opened on Feb 23, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)CSS (3,473 stars) (1,413 forks)batch import
AcceptedBugGood First Issue

Description

Problem

The Chrome Lighthouse auditor report some accessibility problems; _ Color contrast problems in the lateral nav bar _ Missing aria-label in the input search box _ Duplicated access key of the previous and next buttons when variable theme_prev_next_buttons_location == 'both'

Reproducible Project

The first two are available in all rtd doc like: https://sphinx-rtd-theme.readthedocs.io/en/latest/ The third one need variable theme_prev_next_buttons_location == 'both'

Expected Results

Improve Chrome Lighthouse audit score

Contributor guide

Tech stack
htmlcss
Domain
accessibilitydocumentation
Issue type
accessibility
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
HTML accessibilitySphinx theme structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the template files that render the prev/next navigation buttons, likely in the theme's layout.html or a partial template. Look for the access key attribute duplication when `theme prev next buttons location` is set to 'both'. Check for any existing PRs or comments. Consider adding unique access keys by location or removing duplicate.