pydata/pydata-sphinx-theme

Add contributor documentation explaining how to run a single a11y test

Closed

#2,092 opened on Jan 7, 2025

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (388 forks)github user discovery
good first issue

Repository metrics

Stars
 (775 stars)
PR merge metrics
 (Avg merge 1d 14h) (18 merged PRs in 30d)

Description

Is there a way to just run the single a11y test that I'm currently developing? I don't see any guidance on this: https://pydata-sphinx-theme.readthedocs.io/en/stable/community/setup.html#run-the-tests

Contributor guide

Research direction
Check the project's testing configuration (e.g., pytest or Playwright) and document how to run a single a11y test, likely using a test filter or specifying the test function name.
Tech stack
python
Domain
developer experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90