Skip to content

Don't try to populate version switcher w/ relative path on local static site #1660

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

Merged
merged 3 commits into from
Jan 24, 2024
Merged

Don't try to populate version switcher w/ relative path on local static site #1660

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e329478
Don't try to populate version switcher on static sites
dstansby Jan 22, 2024
a79e3aa
Fix comment spelling
dstansby Jan 22, 2024
57c7089
Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js
drammock Jan 22, 2024
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
16 changes: 13 additions & 3 deletions src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,14 @@ async function fetchVersionSwitcherJSON(url) {
var result = new URL(url);
} catch (err) {
if (err instanceof TypeError) {
if (!window.location.origin) {
// window.location.origin is null for local static sites
// (ie. window.location.protocol == 'file:')
//
// TODO: Fix this to return the static version switcher by working out
// how to get the correct path to the switcher JSON file on local static builds
return null;
}
// assume we got a relative path, and fix accordingly. But first, we need to
// use `fetch()` to follow redirects so we get the correct final base URL
const origin = await fetch(window.location.origin, { method: "HEAD" });
Expand Down Expand Up @@ -556,9 +564,11 @@ if (hasVersionsJSON && (hasSwitcherMenu || wantsWarningBanner)) {
const data = await fetchVersionSwitcherJSON(
DOCUMENTATION_OPTIONS.theme_switcher_json_url
);
populateVersionSwitcher(data, versionSwitcherBtns);
if (wantsWarningBanner) {
showVersionWarningBanner(data);
if (data) {
populateVersionSwitcher(data, versionSwitcherBtns);
if (wantsWarningBanner) {
showVersionWarningBanner(data);
}
}
}

Expand Down