Accessibility meta issue

[jarrodmillman]

CAUTION: This is a rough placeholder for upcoming accessibility improvements and needs to be fleshed out in more detail.

We leverage (and plan to leverage more of) the accessibility work being done for the PST (pydata sphinx theme). For example, see https://github.com/pydata/pydata-sphinx-theme/pull/1564

@trallard Here is a partial list of SPHT (scientific python hugo theme) specific work:

• [ ] Theme specific colors
  • https://github.com/scipy/scipy/issues/19958
  • https://github.com/scientific-python/scientific-python-hugo-theme/blob/main/assets/theme-css/vars.css
• [ ] Improved accessibility automated testing
  • https://github.com/pydata/pydata-sphinx-theme/blob/main/tests/test_a11y.py
• [ ] Custom shortcodes
  • [ ] details
  • https://theme.scientific-python.org/shortcodes/#details
  • [ ] tomltotables
  • https://github.com/scientific-python/scientific-python-hugo-theme/pull/572
  • [ ] button @alphapapa: https://github.com/scientific-python/scientific-python-hugo-theme/issues/480
  • https://github.com/scientific-python/scientific-python-hugo-theme/pull/483
  • https://pydata-sphinx-theme--1564.org.readthedocs.build/en/1564/user_guide/web-components.html#badges-and-button-links
  • src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss
  • Unlike PST we will implement buttons as <button> and not <a> tags

[smeragoel]

I have a question regarding the custom shortcodes, specifically the yamltotables component.

1. I don't see the actual component in the link provided (same for youtube)
2. I'll get more context when I see the component, but there's an existing PST tables component and we are doing active accessibility work on it, so we can leverage this component if we aren't already doing so 😸

[jarrodmillman]

@smeragoel Sorry about that. I removed the yamlToTable documentation (#570) because we are switching from yaml to toml for shortcodes (#484). There is a PR in progress, but I haven't finished it (#572). I updated the link above to point to the PR and removed the deadlink. I am planning to use the PST styling in the new PR, but haven't yet made much progress other than adding to class tags used by PST.

I will try to get the tomlToTable PR ready to merge. Thanks for looking into this!

[smeragoel]

Thanks for the update, @jarrodmillman! I'm happy to take a look at the table design once it's ready, so feel free to ping me.

I came across the details component at https://theme.scientific-python.org/shortcodes/#details and noticed its functionality seems quite similar to the toggle buttons found in the PyData Sphinx Theme (https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/web-components.html#toggle-buttons), which also incorporate accessibility features. Was there a specific requirement or purpose that led to the creation of this new component, especially considering its simpler design?

Also, this may not be relevant to this ticket, but I saw that there is a dropdown component (https://theme.scientific-python.org/shortcodes/#dropdown), but it lacks hover interaction and a chevron indicator for expandability - features that are present in the PyData Sphinx Theme's dropdown: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/web-components.html#dropdowns. Is this by design, or are there plans to enhance this component for consistency and usability?

[smeragoel]

@jarrodmillman bumping this up!

[trallard]

Adding this https://github.com/scientific-python/scientific-python-hugo-theme/issues/618 as this seems to be an issue with theming (or lack of theming for dark mode) cc @smeragoel