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.

Sign up for GitHub

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

Jump to bottom

ENH - Theme improvements to the PyData Sphinx theme (colour and focus) #20

Open
6 tasks done
Tracked by #21
trallard opened this issue Jan 11, 2023 · 0 comments
Open
6 tasks done
Tracked by #21

ENH - Theme improvements to the PyData Sphinx theme (colour and focus) #20

trallard opened this issue Jan 11, 2023 · 0 comments
Assignees
@trallard
Labels
area: accessibility ♿ area: PyData-Sphinx mission: access-centred ♿ Access-centred practices work stream mission: web themes 💻 Improvements to documentation themes team: quansight-labs type: task 📌 A concrete, well-scoped item
Milestone
12 months

Comments

@trallard
Copy link
Member

trallard commented Jan 11, 2023 •
edited

📝 Summary

Related to #8

  • A colour contrast check was done by @scmmmh and determined it was best to work on a cohesive colour system for the theme, which will lead to:
    • Adaptable theming - dark and light
    • Improved maintainability
    • Better out-of-the-box colour contrast conformance (Meet WCAG SC 1.4.3 - contrast AA)
  • While working on the colour system, additional design and UX interaction had been done to help with other WCAG criteria

Acceptance Criteria

  • WCAG SC 1.4.3 - text contrast AA
    • 4.5:1 ratio for text and background (text < 18pt or bold text < 14pt)
    • 3:1 ratio for text and background (text >= 18pt or bold text =< 14pt)
  • Focus visible criteria - buttons, links, and navigation components meet at least WCAG 2.1 (designs account for changes in WCAG 2.2
  • WCAG SC 1.4.11 - non-text contrast AA need a minimum 3:1 contrast ratio with adjacent colours
    • link underline
    • focus styles
    • buttons and badges
    • icons
    • dropdowns
  • WCAG SC 1.4.1 - use of colour
    • Color is not used as the only visual means of conveying information, indicating an action, prompting a response, or distinguishing a visual element

Tasks
Beta Give feedback
  3. Implement changes in the PyData Sphinx theme and update documentation as needed - colour #22
    area: PyData-Sphinx area: accessibility ♿ team: quansight-labs type: task 📌
    trallard
  4. Test/audit implementation for colour contrast #24
    2 of 2
    area: PyData-Sphinx area: accessibility ♿ mission: access-centred ♿ team: quansight-labs type: enhancement 💅🏼
    trallard
  5. FOCUS - PyData Sphinx enhancements and documentation #27
    15 of 18
    area: PyData-Sphinx area: UI/UX 🎨 area: accessibility ♿ mission: access-centred ♿
    smeragoel trallard
  6. ENH - Update icons style to meet criteria 1.4.1 #31
    area: accessibility ♿
    smeragoel

🔗 Additional links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@trallard trallard

Labels
area: accessibility ♿ area: PyData-Sphinx mission: access-centred ♿ Access-centred practices work stream mission: web themes 💻 Improvements to documentation themes team: quansight-labs type: task 📌 A concrete, well-scoped item
Projects
czi-scientific-python 🐍
Status: 🏗 In progress
Milestone
12 months
Development

No branches or pull requests
1 participant
@trallard