BUG: API docs difficult to read in dark mode

[dschmitz89]

Describe your issue.

Testing out the dark mode for a recent PR, I found (subjectively) that the API was difficult to read in dark mode due to the yellowish background. The actual parameter docs etc. look fine.

Examples:

While not being a designer I guess that another color would be better for the dark mode.

Reproducing Code Example

Browser: Chrome 103

Error message

Example Doc URL

SciPy/NumPy/Python version information

irrelevant

[melissawm]

I am guessing this is an override from our side, since the demo site from the pydata-sphinx-theme is different:

[tupui]

Ah right it's the highlights color. I will have a look 👀

[tupui]

I had a look and this is because we are using the same colours as NumPy for the body.

We want these 2 projects to have the same feel and this is why we originally went with the same colours. I could fix this by changing the contrast here and on NumPy (e.g. use #939393), but I am not a UX/UI/designer.

I propose to make a meeting with NumPy and SciPy to discuss what we want to do with colours and dark theme. This is not related to the theme itself as here we want to have our own colour scheme. Or you decide on a colour palette for NumPy and we follow here.

cc @seberg @isabela-pf @MarsBarLee @jarrodmillman

[rgommers]

I'd personally prefer to use the theme defaults for SciPy, because the theme is getting wide adoption. NumPy probably should do the same, but that's for the NumPy issue tracker.

[rossbar]

I'd personally prefer to use the theme defaults for SciPy

I second this (ideally numpy & scipy would be in sync here, but of course that's not a requirement).

Note that there is a way to configure the entire palette for syntax highlighting rather than messing with individual colors manually in css - see pydata/pydata-sphinx-theme#649. IMO it'd be a nice improvement to use one of the pygments themes and get rid of any css overrides (this would make it much easier to have consistency across projects as well).

[tupui]

Fine by me it would be easier to not care on our side. I will make a PR to remove our styling then.

[tupui]

Just opened a PR. If there are design/colours concerns, we can address these on the theme side. We have a good working relationship with the theme, they would be happy to get feedbacks on all that and would be happy to make changes for us.