sphinx_rtd_dark_mode icon indicating copy to clipboard operation
sphinx_rtd_dark_mode copied to clipboard

Dark text on dark background in code snippets is difficult to read

Open zaneselvans opened this issue 3 years ago • 4 comments

In some contexts the theme uses a dark-on-dark color combination that's difficult to read. For example, the environment variable name in this shell code snippet:

image

zaneselvans avatar Sep 25 '21 17:09 zaneselvans

Here's a different example of dark-on-dark being unreadable. This is in API documentation built with the sphinx-autoapi extension. Docs from our PUDL repo again.

image

zaneselvans avatar Nov 13 '21 17:11 zaneselvans

I'm also seeing a couple of situations where text is too dark to see:

  1. autodoc light: image dark: image class name is black on black background so can't read.

  2. code-block:: jinja light: image dark: image template variable has dark blue text on black background.

  3. code-block:: python light: image dark: image function name is dark blue text on black background.

These examples are from SQLFluff and you can reproduce these examples from here if needed.

The autodoc one is the main barrier preventing me using this, but the other 95% looks great 😄

jpy-git avatar Dec 20 '21 19:12 jpy-git

Another example.

.. code-block:: console

   $ myapp --version
   myapp 0.5.1

Light: Snag_16f19c8

Dark: Snag_16f6bff

The demonstrated response is too dark.

mrelbe1 avatar Oct 31 '22 15:10 mrelbe1

Is there somebody working on that issue? I have the same one.

photoniker avatar Nov 02 '22 08:11 photoniker