Skip to content
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.

Sign up for GitHub

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

Unpin theme #5129

Merged
merged 3 commits into from
Jan 5, 2023
Merged

Unpin theme #5129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0cd9f8
unpin theme and set default style to light (not dark)
tkknight Jan 5, 2023
ce152de
added whatsnew and fixed typo.
tkknight Jan 5, 2023
b5ff421
minor tweaks
tkknight Jan 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<div id="slim-red-box-banner">
You are viewing the <b>latest</b> unreleased documentation
<b>v{{ version }}</b>. You can switch to a <b>stable</b> version
via the flyout menu in the bottom-right of the screen.
via the flyout menu in the bottom corner of the screen.
</div>
<p></p>
{%- endif %}
Expand Down
6 changes: 6 additions & 0 deletions docs/src/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,9 @@ def _dotv(version):
],
"use_edit_page_button": True,
"show_toc_level": 1,
# Omitted `theme-switcher` below to disable it
# Info: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/light-dark.html#configure-default-theme-mode
"navbar_end": ["navbar-icon-links"],
}

rev_parse = run(["git", "rev-parse", "--short", "HEAD"], capture_output=True)
Expand All @@ -321,6 +324,9 @@ def _dotv(version):
"github_user": "scitools",
"github_version": "main",
"doc_path": "docs/src",
# default theme. Also disabled the button in the html_theme_options.
# Info: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/light-dark.html#configure-default-theme-mode
"default_mode": "light",
# custom
"on_rtd": on_rtd,
"rtd_version": rtd_version,
Expand Down
3 changes: 3 additions & 0 deletions docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ This document explains the changes made to Iris for this release
================

#. `@rcomer`_ clarified instructions for updating gallery tests. (:pull:`5100`)
#. `@tkknight`_ unpinned ``pydata-sphinx-theme`` and set the default to use
the light version (not dark) while we make the docs dark mode friendly
(:pull:`5129`)


💼 Internal
Expand Down
2 changes: 1 addition & 1 deletion requirements/ci/py310.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ dependencies:
- sphinx-copybutton
- sphinx-gallery >=0.11.0
- sphinx-panels
- pydata-sphinx-theme = 0.8.1
- pydata-sphinx-theme

# Temporary minimum pins.
# See https://github.com/SciTools/iris/pull/5051
Expand Down
2 changes: 1 addition & 1 deletion requirements/ci/py38.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ dependencies:
- sphinx-copybutton
- sphinx-gallery >=0.11.0
- sphinx-panels
- pydata-sphinx-theme = 0.8.1
- pydata-sphinx-theme

# Temporary minimum pins.
# See https://github.com/SciTools/iris/pull/5051
Expand Down
2 changes: 1 addition & 1 deletion requirements/ci/py39.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ dependencies:
- sphinx-copybutton
- sphinx-gallery >=0.11.0
- sphinx-panels
- pydata-sphinx-theme = 0.8.1
- pydata-sphinx-theme

# Temporary minimum pins.
# See https://github.com/SciTools/iris/pull/5051
Expand Down