-
Notifications
You must be signed in to change notification settings - Fork 284
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Iris Docs: Dark theme ready #5299
Conversation
* upstream/main: update cf-standard-name-table (SciTools#5297) fix license badge (SciTools#5296)
Will resolve #4795 |
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #5299 +/- ##
=======================================
Coverage 89.35% 89.35%
=======================================
Files 89 89
Lines 22417 22417
Branches 5382 5382
=======================================
Hits 20030 20030
Misses 1639 1639
Partials 748 748 ☔ View full report in Codecov by Sentry. |
* upstream/main: update release_do_nothing script (SciTools#5311) Restore latest Whats New files. Updated environment lockfiles (SciTools#5308) release_do_nothing script updates from v3.6.0rc0 (SciTools#5306) Whats new updates for v3.6.0rc0 (SciTools#5300) Bump scitools/workflows from 2023.04.3 to 2023.05.0 (SciTools#5303)
* upstream/main: Updated environment lockfiles (SciTools#5332) Support netcdf variable emulation (SciTools#5212) Support netCDF load+save on dataset-like objects as well as filepaths. (SciTools#5214) minor refinement to release do-nothing script (SciTools#5326) update bibtex citation for v3.6.0 release (SciTools#5324) Whats new updates for v3.6.0 (SciTools#5323) Added whatsnew notes on netcdf delayed saving and Distributed support. (SciTools#5322) Updated environment lockfiles (SciTools#5320) Bugfix 4566 (SciTools#4569) Simpler/faster data aggregation code in `aggregated_by` (SciTools#4970)
Ready for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @tkknight. At least one fix to an image is needed, plus a few other comments.
Great, thanks @tkknight! Let's save some monitor energy and some retinas 💻👁 ... |
* upstream/main: Updated environment lockfiles (SciTools#5334) Iris Docs: Dark theme ready (SciTools#5299) Updated environment lockfiles (SciTools#5332) Support netcdf variable emulation (SciTools#5212) Support netCDF load+save on dataset-like objects as well as filepaths. (SciTools#5214) minor refinement to release do-nothing script (SciTools#5326) update bibtex citation for v3.6.0 release (SciTools#5324) Whats new updates for v3.6.0 (SciTools#5323) Added whatsnew notes on netcdf delayed saving and Distributed support. (SciTools#5322) Updated environment lockfiles (SciTools#5320) Bugfix 4566 (SciTools#4569) Simpler/faster data aggregation code in `aggregated_by` (SciTools#4970) update release_do_nothing script (SciTools#5311) Restore latest Whats New files. Updated environment lockfiles (SciTools#5308) release_do_nothing script updates from v3.6.0rc0 (SciTools#5306) Whats new updates for v3.6.0rc0 (SciTools#5300) Bump scitools/workflows from 2023.04.3 to 2023.05.0 (SciTools#5303)
🚀 Pull Request
Description
Updates the Iris docs to be dark theme ready. This is a feature that the pydata-sphinx-theme supports.
PR build of the docs: https://scitools-iris--5299.org.readthedocs.build/en/5299/index.html
Changes include
svg
images have an increased border to so when there is a dark background it looks betterdark-light
class where the figure/image is transparent, otherwise the theme will add a white background to the transparent image when using dark more. Sometimes this is ok though so the class has not been used everywhere.Minor issue outstanding
The Iris Voted Issues table looks ok apart from the pulldown and text entry that uses black text on the almost black background, making it very hard to read. This is not a major issue and unless there are objections should not stop this PR.
I expect this issue will resolve itself when
pydata-sphinx-theme
is updated (and we unpin it) or when thedatatables
css is updated.Consult Iris pull request check list