cytomining / pycytominer

Python package for processing image-based profiling data
https://pycytominer.readthedocs.io
BSD 3-Clause "New" or "Revised" License
78 stars 35 forks source link

Add dark mode style color for contrast in docs #429

Closed d33bs closed 1 month ago

d33bs commented 1 month ago

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?

Checklist

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


šŸ“š Documentation preview šŸ“š: https://pycytominer--429.org.readthedocs.build/en/429/

d33bs commented 1 month ago

Thanks @kenibrewer ! Going to merge this in.