[fix] prefers-color-scheme: use dark theme if body[data-theme="auto"] #154
Conversation
Before this patch the CSS implementation assumes that "dark" is supported by the theme if the `data-theme` attribute of the <body> tag is unset. Since most themes are using "light" colors (compare https://sphinx-themes.org) and do not set `data-theme` it is better to assume light is the default, even when the browser setting `prefers-color-scheme: dark`! BTW: remove duplication of styles from dark/light theme that are already set in the common style. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
The myst-parser requires >= docutils v.0.17 what ends in a dependency hell where plugins sphinx-tabs and sphinx-jinja we use are involved. This patch can be reverted when [2], [3], [4] are solved and new release is available / see [1]. [1] searxng#954 [2] executablebooks/sphinx-tabs#152 [3] executablebooks/sphinx-tabs#153 [4] executablebooks/sphinx-tabs#154 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
|
@foster999 sorry for being impatient again .. can you merge and release? Its not only my project also documentation from many other projects are suffered by this issue / e.g. all projects at RTD that are using sphinx-tabs (without pinning an old version) .. By example, switch your browser to prefer dark mode and visit RTD / e.g.: https://sphinx-notfound-page.readthedocs.io/en/latest/installation.html
Another example is sphnix-tabs @ RTD itself: https://sphinx-tabs.readthedocs.io/en/latest/ Thanks! |
Codecov Report
@@ Coverage Diff @@
## master #154 +/- ##
=======================================
Coverage 92.69% 92.69%
=======================================
Files 2 2
Lines 219 219
=======================================
Hits 203 203
Misses 16 16
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
|
I'm sure you don't need me to tell you that not pinning your dependencies is a bad idea 😉 |
Depends .. pinning a library at major version level is often common .. applications are often pinned at minor level (to get bug fixes) .. but it is handled different in the projects. EDIT forgot to say / thanks for review & merge! |
|
@foster999 could you deploy a bugfix release (3.3.1) at PyPI .. thanks! |
|
@return42 new version is released :) |
|
Thanks very much for this fix @return42 |
Before this patch the CSS implementation assumes that "dark" is supported by the
theme if the
data-themeattribute of the<body>tag is unset.Since most themes are using "light" colors (compare https://sphinx-themes.org)
and do not set
data-themeit is better to assume light is the default, evenwhen the browser setting
prefers-color-scheme: dark!BTW: remove duplication of styles from dark/light theme that are already set in
the common style.
To test enable dark mode in your browser (prefers-color-scheme: dark).
Current master (default theme):
After this patch applied (default theme):
I also tested
furotheme which supports a dark/light mode. This is the result when browser (prefers-color-scheme: dark):BTW: the result is the same if you toggle from "auto" to "dark".
And here is the result when you toggle into "light" mode ..
Closes: #152