From a3a7f700f7a9cb195a6af16afbdee10544b4bd2c Mon Sep 17 00:00:00 2001 From: Isabela Presedo-Floyd Date: Fri, 21 Feb 2025 12:59:12 -0800 Subject: [PATCH 1/3] Create accessibility statement --- docs/community/accessibility-statement.md | 74 +++++++++++++++++++++++ docs/community/index.md | 1 + 2 files changed, 75 insertions(+) create mode 100644 docs/community/accessibility-statement.md diff --git a/docs/community/accessibility-statement.md b/docs/community/accessibility-statement.md new file mode 100644 index 000000000..0e4c352e8 --- /dev/null +++ b/docs/community/accessibility-statement.md @@ -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. diff --git a/docs/community/index.md b/docs/community/index.md index 27978d892..79aeb3019 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -30,4 +30,5 @@ practices/* contributors inspiration design-system +accessibility-statement ``` From 4ead4b44ca17f07e06f40effeeb2a97c8c10dc71 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 21 Feb 2025 21:14:46 +0000 Subject: [PATCH 2/3] [pre-commit.ci] Automatic linting and formatting fixes --- docs/community/accessibility-statement.md | 36 +++++++++++------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/community/accessibility-statement.md b/docs/community/accessibility-statement.md index 0e4c352e8..ec45f643b 100644 --- a/docs/community/accessibility-statement.md +++ b/docs/community/accessibility-statement.md @@ -4,8 +4,8 @@ This accessibility statement applies to -* The PyData Sphinx Theme -* This documentation website, which uses the PyData Sphinx Theme +- 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. @@ -13,10 +13,10 @@ Other projects that use the PyData Sphinx Theme will inherit the theme's accessi 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. +- 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 @@ -28,9 +28,9 @@ PyData Sphinx Theme is **fully conformant** with [Web Content Accessibility Guid 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 +- 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 @@ -42,20 +42,20 @@ Please let us know if you encounter accessibility barriers on PyData Sphinx Them PyData Sphinx Theme is tested automatically on the following and expected to work best: -* Chrome -* Ubuntu +- 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) +- 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 +- Safari ## Assessment approach @@ -63,7 +63,7 @@ The PyData Sphinx Theme community has self-assessed the theme manually with the PyData Sphinx Theme has not been assessed by a professional auditor. -### Most recent assesment +### Most recent assesment The most recent accessibility assessment for PyData Sphinx Theme was conducted in 2024 using Accessibility Insights. From 5eb6d4ff07bca5e070ba8f9baf5f380b510eb63e Mon Sep 17 00:00:00 2001 From: Isabela Presedo-Floyd <50221806+isabela-pf@users.noreply.github.com> Date: Tue, 25 Feb 2025 16:31:42 -0800 Subject: [PATCH 3/3] Apply suggestions from @trallard Co-authored-by: Tania Allard --- docs/community/accessibility-statement.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/community/accessibility-statement.md b/docs/community/accessibility-statement.md index ec45f643b..61e1024a5 100644 --- a/docs/community/accessibility-statement.md +++ b/docs/community/accessibility-statement.md @@ -7,11 +7,11 @@ 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. +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). ## Measures to support accessibility -The team has taken the following measures to ensure the accessibility of the PyData Sphinx Theme +The PyData Sphinx Theme 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.