Skip to content

Commit 095db00

Browse files
isabela-pfIsabela Presedo-Floydpre-commit-ci[bot]trallard
authored andcommitted
[DOC] Create accessibility statement (pydata#2135)
@trallard asked me to create an accessibility statement for the theme based on all the accessibility changes that have been done on this project in recent years. @smeragoel, @gabalafou, and @trallard all helped me get this document into shape; kudos to them! This PR: - Adds `accessibility-statement.md` with the common sections for accessibility statements filled out - Adds Accessibility Statement to the Contributor Guide/About the project section of the documentation The contents of the statement and its location in the documentation would both benefit from review. Please let me know if you have questions or if there's anything you find missing. Thank you in advance! 🌻 --------- Co-authored-by: Isabela Presedo-Floyd <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Tania Allard <[email protected]>
1 parent aa034af commit 095db00

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed
+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Accessibility Statement for Pydata Sphinx Theme Draft
2+
3+
## Scope of statement
4+
5+
This accessibility statement applies to
6+
7+
- The PyData Sphinx Theme
8+
- This documentation website, which uses the PyData Sphinx Theme
9+
10+
Other projects that use the PyData Sphinx Theme will inherit the theme's accessibility if they set up their projects with theme defaults. Other projects are ultimately outside this community's control (for example, content/documentation creators are responsible for ensuring any customizations and content added are accessible).
11+
12+
## Measures to support accessibility
13+
14+
The PyData Sphinx Theme team has taken the following measures to ensure the accessibility of the PyData Sphinx Theme
15+
16+
- Agree to accessibility goals for the theme.
17+
- Acquire funding for contributors to make and test large accessibility changes.
18+
- Integrate accessibility into our review and decision-making processes.
19+
- For example, code changes that break the automated accessibility tests are automatically blocked by the system until the test failures are fixed.
20+
21+
## Conformance
22+
23+
### Current status
24+
25+
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.
26+
27+
### Goals
28+
29+
PyData Sphinx theme aims to
30+
31+
- Provide an equitable user experience, inclusive of disability
32+
- Conform with Web Content Accessibility Guidelines (WCAG) 2.1 level AA
33+
- Make all features compatible with assistive technology
34+
35+
## Known issues
36+
37+
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`.
38+
39+
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.
40+
41+
## Testing and compatibility
42+
43+
PyData Sphinx Theme is tested automatically on the following and expected to work best:
44+
45+
- Chrome
46+
- Ubuntu
47+
48+
PyData Sphinx Theme is tested ad hoc manually on the following and expected to work well:
49+
50+
- Firefox
51+
- MacOS
52+
- Windows
53+
- VoiceOver (by people who are not regular screen reader users)
54+
- NVDA (by people who are not regular screen reader users)
55+
56+
PyData Sphinx Theme is not tested on the following and may or may not work as expected:
57+
58+
- Safari
59+
60+
## Assessment approach
61+
62+
The PyData Sphinx Theme community has self-assessed the theme manually with the assistance of the software program [Accessibility Insights](https://accessibilityinsights.io/).
63+
64+
PyData Sphinx Theme has not been assessed by a professional auditor.
65+
66+
### Most recent assesment
67+
68+
The most recent accessibility assessment for PyData Sphinx Theme was conducted in 2024 using Accessibility Insights.
69+
70+
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).
71+
72+
## Date
73+
74+
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.

docs/community/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,5 @@ practices/*
3030
contributors
3131
inspiration
3232
design-system
33+
accessibility-statement
3334
```

0 commit comments

Comments
 (0)