Skip to content

Commit e972f97

Browse files
gabalafoutrallard
andauthored
Apply suggestions from code review
Co-authored-by: Tania Allard <[email protected]>
1 parent 009404d commit e972f97

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/community/topics/accessibility.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,21 @@ wrote a few other Playwright scripts to ensure that certain theme components can
3333
be accessed using only the keyboard. All of our tests currently live in a file
3434
called
3535
[test_a11y.py](https://github.com/pydata/pydata-sphinx-theme/blob/main/tests/test_a11y.py).
36+
:::{note}
3637
We would love contributions that add more accessibility checks to our test
3738
suite.
39+
:::
3840

3941
We have also made these tests part of our continuous integration process, so
40-
that they are run in the cloud before we merge in new changes to the theme. We
41-
use GitHub Actions to provision machines in the cloud. We use Tox to install the
42-
needed dependencies on those machines. We use Pytest with the plug-in for
43-
Playwright to run the tests. Look for the string "accessibility" in the file
42+
they are run in the cloud before we merge in new changes to the theme. We
43+
use the following tools:
44+
* GitHub Actions to provision machines in the cloud
45+
* `tox` to install the needed dependencies on those machines
46+
* `Pytest` with the Playwright plug-in to run the tests.
47+
48+
Look for the string "accessibility" in the file
4449
[CI.yml](https://github.com/pydata/pydata-sphinx-theme/blob/main/.github/workflows/CI.yml)
4550
to find how we have configured GitHub Actions.
46-
4751
## Known limitations and manual auditing
4852

4953
We are well aware that automated checks fall far short of comprehensive
@@ -54,5 +58,4 @@ findings](https://github.com/Quansight-Labs/czi-scientific-python-mgmt/issues/72
5458

5559
Nearly all of the issues have been fixed, but of course things do break / have
5660
already broken, and some things may have never been discovered, so please
57-
[create an issue](https://github.com/pydata/pydata-sphinx-theme/issues/new) on
58-
GitHub if you find something inaccessible.
61+
[create a GitHub issue](https://github.com/pydata/pydata-sphinx-theme/issues/new) if you find something inaccessible.

0 commit comments

Comments
 (0)