-
Notifications
You must be signed in to change notification settings - Fork 354
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
docs: update aria labelling for sidebar toggles and toctree groups #7381
Conversation
✅ Deploy Preview for determined-ui canceled.
|
Docsite preview being generated for this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did a make clean && make get-deps && make build && make live
and it looks like it is building and serving without a hitch. But when I look at the targeted toctree-checkbox
areas based on the report, they haven't changed as shown in the screenshot below. Maybe the changes are not coming through?
For the toctree-checkbox
issues, they are basically invisible checkboxes to keep track of collapsible state of the sidebar menu. It might be best to apply the following attribute instead?
aria-hidden="true"
UPDATE: I'm not seeing your changes in the forked branch in the new build. What do you typically do for your local build? It seems like it's pulling in the right dependency but the changes in the branch don't seem to be in the newly built doc...
❯ make get-deps
pip install -r requirements.txt
Collecting pydata-sphinx-theme@ git+https://github.com/determined-ai/pydata-sphinx-theme@chore/WEB-1292/hpe-accessibility-patches
Cloning https://github.com/determined-ai/pydata-sphinx-theme (to revision chore/WEB-1292/hpe-accessibility-patches) to /private/var/folders/ws/1f9qnqy5543c1ymspl1bkgnr0000gp/T/pip-install-8sto9o42/pydata-sphinx-theme_ff07c9aff8ff479f9604f1dc1b0e6e05
Running command git clone --filter=blob:none --quiet https://github.com/determined-ai/pydata-sphinx-theme /private/var/folders/ws/1f9qnqy5543c1ymspl1bkgnr0000gp/T/pip-install-8sto9o42/pydata-sphinx-theme_ff07c9aff8ff479f9604f1dc1b0e6e05
Running command git checkout -b chore/WEB-1292/hpe-accessibility-patches --track origin/chore/WEB-1292/hpe-accessibility-patches
Switched to a new branch 'chore/WEB-1292/hpe-accessibility-patches'
branch 'chore/WEB-1292/hpe-accessibility-patches' set up to track 'origin/chore/WEB-1292/hpe-accessibility-patches'.
Resolved https://github.com/determined-ai/pydata-sphinx-theme to commit e3a365c78e79f10923d3a46c001fa3bef8833550
Installing build dependencies ... done
Getting requirements to build wheel ... done
Preparing metadata (pyproject.toml) ... done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docsite preview being generated for this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM thanks for the changes!
Description
This updates the docs to fix the accessibility issues highlighted in the levelaccess tool.
In order to do this properly, we fork the pydata-sphinx-theme python package and make the changes there. The changes to the package can be seen in determined-ai/pydata-sphinx-theme#1 -- once approved, we can change the branch this PR is pointing to to main.
Test Plan
Docs site should not have any 10 severity accessibility issues in levelaccess.
Checklist
docs/release-notes/
.See Release Note for details.
Ticket
WEB-1292