pydata / pydata-sphinx-theme

A clean, three-column Sphinx theme with Bootstrap for the PyData community
https://pydata-sphinx-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
600 stars 313 forks source link

Make announcement banner into a landmark (aside/complementary) #1793

Closed gabalafou closed 4 months ago

gabalafou commented 5 months ago

One of many fixes for #1428.

Axe-core wants: all page content should be contained by landmarks.

The announcement banner was not a landmark, nor contained by one, so this PR:

This follows the implementation of the Black Lives Matter banner on a11yproject.com (i.e, an aside + aria-label).

I thought about putting both banners (version warning + announcement) together into a single landmark, but my thinking is that for sighted users, both banners are visually distinguishable and draw attention to themselves on every page, so I think making them both into separate landmarks achieves the same level of emphasis for both sighted and non-sighted users. It's also the simpler, more straightforward implementation.

After this PR, the landmarks read:

Note: we need to fix the section navigation landmark since it repeats the word navigation twice.

trallard commented 4 months ago

Thanks @gabalafou, this looks good!

Note: we need to fix the section navigation landmark since it repeats the word navigation twice. Assume this will be done in a separate PR?