iris icon indicating copy to clipboard operation
iris copied to clipboard

Published 20 hours ago • verified publisher icon SciTools

Iris Documentation: Needs to be dark mode friendly

Open tkknight opened this issue 3 years ago • 3 comments

📚 Documentation

pydata-sphinx-theme has been updated from 0.8.1 to 0.9.0. The later version supports dark mode which is great, however the iris docs will need a few changes like image transparency, dark friendly logo, etc.

image

The biggest item to fix is the expandable panels colours are not associated with the theme (always white).

image

Suggest we:

  • [ ] Pin to version 0.8.1 whilst we update the docs (https://github.com/SciTools/iris/pull/4796)
  • [ ] Fix the mentioned issues
  • [ ] Unpin

tkknight avatar Jun 13 '22 14:06 tkknight

dark friendly logo

#3935

trexfeathers avatar Jun 13 '22 14:06 trexfeathers

Dark mode is already showing in the latest docs 😕

ECCD371D-3A6A-44AA-B6E9-91023FCC1501

rcomer avatar Jun 16 '22 07:06 rcomer

I believe that is due to readthedocs (latest) using the main branch for the requirements, that use use the env definition https://github.com/SciTools/iris/blob/main/requirements/ci/readthedocs.yml (symlink to iris.yml -> py38.yml).

PR https://github.com/SciTools/iris/pull/4796 to pin to the non dark mode version has not been merged just yet. We have some CI issues atm so the PR will not pass - feel free to merge though, it is a minor change.

tkknight avatar Jun 16 '22 08:06 tkknight

  • SciTools/marketing#2

trexfeathers avatar Jan 03 '23 13:01 trexfeathers