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

Footnote contrast is too low #1153

Open
mara004 opened this issue May 26, 2021 · 6 comments
Open

Footnote contrast is too low #1153

mara004 opened this issue May 26, 2021 · 6 comments
Labels
Accepted Accepted issue on our roadmap Bug A bug

Comments

@mara004
Copy link

mara004 commented May 26, 2021

Problem

The contrast of footnote texts clearly is too low, making them hard to read (light grey on white). However, they should not be too invisible, since footnotes sometimes contain important information.
Low contrast is annoying for everyone, but it is particularly bad for visually impaired people and reduces accessibility.

Reproducible Project

This is a text with an interesting footnote [1]_

.. [1] When compiling the documentation, the contrast of this text will be way too low

shpinx-rtd-theme_low-contrast-footnote

Expected Results

Consider using the normal black text colour for footnotes, or at least take a darker grey.

Environment Info

  • Python Version: 3.8.5
  • Sphinx Version: 4.0.2
  • RTD Theme Version: 0.5.2
@mara004 mara004 added Bug A bug Needed: replication Bug replication is required labels May 26, 2021
@stsewd stsewd added Accepted Accepted issue on our roadmap and removed Needed: replication Bug replication is required labels May 26, 2021
@mara004
Copy link
Author

mara004 commented Nov 2, 2022

I think this got fixed with v1.1.0 - thanks!

@mara004 mara004 closed this as completed Nov 2, 2022
@benjaoming
Copy link
Contributor

Hi! Thanks for getting back to this issue!

I'm not sure how much contrast is desirable - but does the new footnote representation look good enough for you?

https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/demo.html#footnotes

Otherwise, please feel free to reopen and weigh in! I think using a darker grey is a good option, but using the same color as the remaining text will make footnote blocks harder to decode or slightly less elegant if that term seems meaningful :)

@mara004
Copy link
Author

mara004 commented Nov 2, 2022

Hmm, on my local documentation build that looked different:
image
(Note: The black background is because I'm using Chromium's auto dark mode - this is the RTD theme indeed)

The demo still shows the low contrast I initially reported, so I'll re-open the issue.

@mara004 mara004 reopened this Nov 2, 2022
@mara004
Copy link
Author

mara004 commented Nov 2, 2022

Ah, turns out I had a mismatched version of docutils installed (0.18.1 but sphinx-rtd-theme currently needs <0.18).
Once I corrected that, it's the low-contrast style again:
image

However, I have to admit I kind of preferred the other rendering even though it seems to have been a bug.

@benjaoming
Copy link
Contributor

We are making changes to the footnote rendering with docutils 0.18 👍

We can solve this issue in #1351

@mara004
Copy link
Author

mara004 commented Nov 3, 2022

@benjaoming Thanks for clarifying!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Bug A bug
Projects
None yet
Development

No branches or pull requests

3 participants