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

Accessibility migration #95

Open
14 of 22 tasks
jorgepiloto opened this issue Aug 11, 2022 · 6 comments
Open
14 of 22 tasks

Accessibility migration #95

jorgepiloto opened this issue Aug 11, 2022 · 6 comments
Labels
enhancement New features or code improvements

Comments

@jorgepiloto
Copy link
Member

jorgepiloto commented Aug 11, 2022

🐞 Problem
Our ansys-sphinx-theme is not compliant with accessibility guidelines, see:

Notice that some of the features we use are inherited from the pydata-sphinx-theme. Thus, any accessibility improvements we make could be moved at some point to this other theme.

📝 Solution
After discussing privately, here is a list of the issues that need to be addressed for making our theme more accessible:

  • Color related

    • Stop using Ansys gold and use near black
    • Same applies for header links
    • Hyperlinks must be vibrant blue
  • Top navigation bar

    • Top navigation bar needs to reflect "normal", "active" and "hover" states
    • Active navigation bar section needs to be underlined
    • Navigation bar toggler dropdown must be visible in both light and dark theme
  • Left sidebar

    • Fix styling when hovering and for active section
    • Fix visibility when using a narrow browser
  • Right sidebar

    • Fix styling when hovering and for active section
    • Fix margin (this needs further discussion)
    • Fix titles
  • Breadcrumbs

    • Remove bottom border
  • Body content

    • Remove maximum width restriction on container
    • Impose auto margin
  • Admonitions theme

    • Color for admonitions
      admonisions

👥 Teams
This topic was originally raised by @timdansys and discussed with documentation and PyAnsys team. Pinging here all people related with this issue: @PipKat @MaxJPRey @RobPasMue @Revathyvenugopal162

🔗 References

Acesibility guidelines: https://www.w3.org/WAI/standards-guidelines/wcag/

@jorgepiloto
Copy link
Member Author

Linking here the pull requests which partially addressed this issue: #90 and #93.

@Revathyvenugopal162
Copy link
Collaborator

Marking the addressed problems in #90 and #93.

@jorgepiloto jorgepiloto added the enhancement New features or code improvements label Aug 11, 2022
@RobM-official
Copy link

not me! I think you wanted @RobPasMue

@Revathyvenugopal162
Copy link
Collaborator

  • Admonitions theme.
    • color for admonitions
      admonisions

@RobPasMue
Copy link
Member

Already created an issue on this last point: #100

@germa89
Copy link
Collaborator

germa89 commented Oct 31, 2022

I think #121 this is also relevant here...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

No branches or pull requests

5 participants