Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Create accessibility statement #2135

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions docs/community/accessibility-statement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Accessibility Statement for Pydata Sphinx Theme Draft

## Scope of statement

This accessibility statement applies to

- The PyData Sphinx Theme
- This documentation website, which uses the PyData Sphinx Theme

Other projects that use the PyData Sphinx Theme will inherit the theme's accessibility if they set up their projects with theme defaults, but other projects are ultimately outside this community's control.

## Measures to support accessibility

The team has taken the following measures to ensure the accessibility of the PyData Sphinx Theme

- Agree to accessibility goals for the theme.
- Acquire funding for contributors to make and test large accessibility changes.
- Integrate accessibility into our review and decision-making processes.
- For example, code changes that break the automated accessibility tests are automatically blocked by the system until the test failures are fixed.

## Conformance

### Current status

PyData Sphinx Theme is **fully conformant** with [Web Content Accessibility Guidelines (WCAG)](https://www.w3.org/WAI/standards-guidelines/wcag/) 2.1 level A and **partially conformant** with [Web Content Accessibility Guidelines (WCAG)](https://www.w3.org/WAI/standards-guidelines/wcag/) 2.1 level AA.

### Goals

PyData Sphinx theme aims to

- Provide an equitable user experience, inclusive of disability
- Conform with Web Content Accessibility Guidelines (WCAG) 2.1 level AA
- Make all features compatible with assistive technology

## Known issues

Up-to-date [accessibility issues](https://github.com/pydata/pydata-sphinx-theme/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22tag%3A%20accessibility%22) can be found on the PyData Sphinx Theme repository labeled `accessibility`.

Please let us know if you encounter accessibility barriers on PyData Sphinx Theme by [submitting an issue](https://github.com/pydata/pydata-sphinx-theme/issues) on the PyData Sphinx Theme repository.

## Testing and compatibility

PyData Sphinx Theme is tested automatically on the following and expected to work best:

- Chrome
- Ubuntu

PyData Sphinx Theme is tested ad hoc manually on the following and expected to work well:

- Firefox
- MacOS
- Windows
- VoiceOver (by people who are not regular screen reader users)
- NVDA (by people who are not regular screen reader users)

PyData Sphinx Theme is not tested on the following and may or may not work as expected:

- Safari

## Assessment approach

The PyData Sphinx Theme community has self-assessed the theme manually with the assistance of the software program [Accessibility Insights](https://accessibilityinsights.io/).

PyData Sphinx Theme has not been assessed by a professional auditor.

### Most recent assesment

The most recent accessibility assessment for PyData Sphinx Theme was conducted in 2024 using Accessibility Insights.

The results of that assessment were not formally published, but the problems revealed by the audit were turned into individual GitHub issues and collected into a [single issue](https://github.com/Quansight-Labs/czi-scientific-python-mgmt/issues/72).

## Date

This statement was created in February 2025 using the [W3C Accessibility Statement Generator Tool](https://www.w3.org/WAI/planning/statements/generator/#create). It was then edited to fit the accessibility efforts of the PyData Sphinx Theme community. It was last updated in February 2025.
1 change: 1 addition & 0 deletions docs/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,5 @@ practices/*
contributors
inspiration
design-system
accessibility-statement
```
Loading