-
Notifications
You must be signed in to change notification settings - Fork 7
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
Modify css for better web accessibility #90
Modify css for better web accessibility #90
Conversation
Thanks for addressing this, @Revathyvenugopal162. Let me ping here @timdansys so he is aware about the changes we introduce regarding accessibility. Tim is still working on his notes and will share those in the incoming days. |
From our private discussion, I think that inline code snippets (i.e. anything between ``) should also have a gray background. See this example in pydata-sphinx-theme. |
@Revathyvenugopal162 Your changes look good to me. I'll let Jorge, Maxime, or Roberto be the approver though. The one thing I do remember Tim talking about is our possibly using gray boxes like this for inline code (literal tagging): However, I went to https://new.scipy.org/ to see what the doc for all the big scientific packages looked like. Sphinx was used for all but the IPthon doc, which was far less attractive and usable. All the the others used Sphinx, and of those, SymPy was the only one that used a custom-branded green color scheme that isn't appealing to me at all! Consequently, I'm OK with the pinkish-red color. |
Jorge's suggestion is a great compromise. I think in the gray highlighted box, the pinkish-red text is easier to read than the black text. |
Added the inline code gray background.Thanks @PipKat and @jorgepiloto for pointing this |
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 apart from the mentioned comments and @jorgepiloto's and @PipKat's suggestions. Can you update the screenshots to the latest versions after your changes?
By the way, I thought we were going to change the color and way of showing the top bar menus when hovering or accessing (e.g. using an underline). Will this be handled in this PR @Revathyvenugopal162? |
I think we can implement the "chapter underline" in a separate pull request, @RobPasMue @Revathyvenugopal162. Also, @timdansys still needs to share with use his final notes about the new style. I would be nice to implement the proposed changes in issues to have a better idea on what has been implemented so far. |
############### | ||
Dropdown button | ||
############### | ||
*/ | ||
|
||
.navbar button.navbar-toggler { | ||
margin-right: 1em; | ||
border-color: rgb(255, 255, 255); | ||
color: rgb(255, 255, 255); |
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.
@Revathyvenugopal162 Thanks for adding it. 👍
Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
@jorgepiloto and @PipKat I agree, the contrast is better than for numpy |
I'm not entirely sure if it's worth making a new issue for this, but if we're thinking about accessibility - the contrast for the blue links, pink code/quote sections, and orange syntax highlighting in light mode is below the recommended value: The WCAG guidelines - https://www.w3.org/WAI/standards-guidelines/wcag/ are probably worth following in this case, and aiming for Below is the suggested minimum contrast level in light mode: Links - #0077B3 |
Thanks @da1910 for the color values. Adding these values. |
@@ -116,7 +116,7 @@ html[data-theme="dark"] { | |||
* layout | |||
*/ | |||
|
|||
--pst-color-link: #0088CC; | |||
--pst-color-link: #0077B3; |
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.
We shouldn't change this, #0077B3 also fails accessibility guidelines in dark mode.
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.
Looks good for contrast now!
Merging. Thanks @MaxJPRey @jorgepiloto @RobPasMue @PipKat @da1910 for the thorough review. |
This PR mainly focusing on:
pink