MrDogeBro / sphinx_rtd_dark_mode

Adds a toggleable dark mode to the Read the Docs theme for Sphinx.
sphinx-rtd-dark-mode.vercel.app
MIT License
49 stars 15 forks source link

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

Open zaneselvans opened 2 years ago

zaneselvans commented 2 years ago

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 commented 2 years ago

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

jpy-git commented 2 years ago

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 😄

mrelbe1 commented 1 year ago

Another example.

.. code-block:: console

   $ myapp --version
   myapp 0.5.1

Light: Snag_16f19c8

Dark: Snag_16f6bff

The demonstrated response is too dark.

photoniker commented 1 year ago

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