Skip to content

Accessibility migration #95

@jorgepiloto

Description

@jorgepiloto

🐞 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/

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementGeneral improvements to existing features

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions