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

Improve accessibility with image alternative text #527

Open
ksuess opened this issue Sep 14, 2021 · 5 comments
Open

Improve accessibility with image alternative text #527

ksuess opened this issue Sep 14, 2021 · 5 comments

Comments

@ksuess
Copy link
Member

ksuess commented Sep 14, 2021

  • Check for alternative text for images (alt attribute)
@stevepiercy
Copy link
Contributor

stevepiercy commented Sep 14, 2021

Search for {figure} and {image} and get count of instances (326). Compare against count of :alt: (128).

Do we want to make alt required? (I would vote "yes".)

If we require this, then we must document that it is required. Currently we have only an example without stating that alt is required. That would go best in docs/contributing/markup-syntax.md.

Also add an explanation or reference. For example:

Why use an alt tag?

@ksuess
Copy link
Member Author

ksuess commented Sep 14, 2021

This is a job to do: adding alt attributes in existing docu.

After this is done I would vote for documenting alt attribute as required and add a check.

@stevepiercy
Copy link
Contributor

Is there an easy way to automate checking images for alt text in GitHub Actions or Sphinx?

@stevepiercy
Copy link
Contributor

I could not find any automatic alt text enforcer under sphinx-contrib.

I found a tool called Sa11y that might be helpful after deployment, but it is manual.

Maybe @polyester knows of a tool?

@stevepiercy stevepiercy changed the title Improve accessibility Improve accessibility with image alternative text Sep 19, 2021
@stevepiercy stevepiercy added this to the Relaunch milestone Sep 19, 2021
@ksuess ksuess closed this as completed Oct 14, 2024
@stevepiercy
Copy link
Contributor

@ksuess Why did you close this? It is not complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants