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

Add dark mode style color for contrast in docs #429

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Sep 9, 2024

Description

This PR addresses #428 by allowing the documentation to use distinct colors for styling in light and dark modes. While I made these changes I also slightly reorganized the comments and code nearby for the Sphinx theme configuration.

Additionally, I noticed Read the Docs builds were failing, seemingly due to the environment not installing properly from Poetry. I added a small fix to .readthedocs.yml to try and re-enable builds which seems to have worked.

I manually tested the web accessibility of the color contrast using Lighthouse through the developer console in Chrome. Let me know if you think we should update the color to a different one based on the contrast or how it aligns with other styling.

Closes #428

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

📚 Documentation preview 📚: https://pycytominer--429.org.readthedocs.build/en/429/

@d33bs d33bs changed the title Add distinct dark mode style color for docs Add dark mode style color for contrast in docs Sep 9, 2024
@d33bs d33bs marked this pull request as ready for review September 9, 2024 21:02
Copy link
Member

@kenibrewer kenibrewer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@d33bs
Copy link
Member Author

d33bs commented Sep 12, 2024

Thanks @kenibrewer ! Going to merge this in.

@d33bs d33bs merged commit 37cf141 into cytomining:main Sep 12, 2024
11 checks passed
@d33bs d33bs deleted the docs-link-color branch September 12, 2024 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Increase color contrast for links color with rendered docs in dark-mode
2 participants