Document how to remove the automatic white background for images with the dark theme

[12rambau]

I didn't follow when this modification was included but this morning all the images of my documentation has gained a white background.

Experimenting a bit I realized that the images that have not the "only-dark" class are automatically earning this new white colored background. In the case of my documentation that is using images that work for both I don't need such a change and I don't want to duplicate my images or add extra parameter to every figures to leave them as they are.

Is there a global html parameter to deactivate this modification ?
Is it really needed ?

pydata-sphinx-theme/src/pydata_sphinx_theme/assets/styles/variables/_color.scss

Line 114 in 6f14f45

.bd-content img:not(.only-dark) {

[choldgraf]

I think the question here comes down to deciding which is more common:

• People have images that work in both black/white themes, and adding a white background makes it worse in dark mode
• People have images that only work in a white theme, and adding a white background makes the default better in dark more

My feeling was that the second option is more common which is why we added this (we got several reports of people saying that their plot outlines etc didn't show up properly because they were in black). But if others generally disagree we can figure out another way around this, maybe with a config flag or something?

[12rambau]

I agree with your guess I just wanted to check if other would agree with a config parameter

[choldgraf]

a config parameter seems reasonable to me - though couldn't you also just turn this off with your own manual CSS? e.g.:

      .bd-content img:not(.only-dark) {
        background: unset;
      }

[drammock]

My feeling was that the second option is more common

That is also my impression

couldn't you also just turn this off with your own manual CSS

I had the same thought. IMO either we provide a config flag or we provide a CSS snippet in the docs so users don't have to figure it out themselves. Slight preference for the latter

[12rambau]

a config parameter seems reasonable to me - though couldn't you also just turn this off with your own manual CSS? e.g.:

This is what I did in my own documentation (openforis/sepal-doc@cb30410). fine by me as well