python / python-docs-theme

Sphinx theme for Python documentation
Other
74 stars 58 forks source link

Dark mode: highlighted footnote unreadable #161

Closed hugovk closed 8 months ago

hugovk commented 8 months ago
  1. Go to https://docs.python.org/3.13/library/gettext.html (uses Sphinx 6.2.1)
  2. Switch to dark mode if in light
  3. Click the "[1]" or "[2]" link to jump to the footnote

Expected result: Text is readable

Actual result: Uses a yellow background suitable for light mode, not dark, making text unreadable:

image

This is because of this CSS in https://docs.python.org/3.13/_static/basic.css:

.footnote:target {
    background-color: #ffa;
}

This CSS comes from Sphinx:

https://github.com/sphinx-doc/sphinx/blob/35965903177c6ed9a6afb62ccd33243a746a3fc0/sphinx/themes/basic/static/basic.css_t#L715-L717

But I guess we should fix it in this theme?

Note: Cannot reproduce with https://docs.python.org/3.12/library/gettext.html because it uses Sphinx 4.5.0, and the CSS only applies to the structure in 5+.

ferdnyc commented 6 months ago

Note: Cannot reproduce with https://docs.python.org/3.12/library/gettext.html because it uses Sphinx 4.5.0, and the CSS only applies to the structure in 5+.

Bummer: Now it can be reproduced there. I guess the site pulled in Sphinx updates, but not updates to the theme!

(Edit: Currently reproduces in the docs for 3.11, 3.12, and 3.13.)

hugovk commented 6 months ago

It's not releases yet :) https://github.com/python/python-docs-theme/pull/162#issuecomment-1911546345

But thanks for the ping!