Skip to content

GH-38240: [Docs] version_match should match the version from versions.json#38241

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
jorisvandenbossche merged 3 commits into from
Oct 17, 2023
Merged

GH-38240: [Docs] version_match should match the version from versions.json #38241

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11bc973
Change version_match version
AlenkaF Oct 12, 2023
461841c
Use full versions.json url
AlenkaF Oct 12, 2023
26a6561
Revert json_url change
AlenkaF Oct 17, 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
10 changes: 9 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -288,6 +288,14 @@
# documentation.
#

switcher_version = version
if ".dev" in version:
switcher_version = "dev/"
else:
# If we are not building dev version of the docs, we are building
# docs for the stable version
switcher_version = ""

@jorisvandenbosschejorisvandenbosscheOct 12, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realize a potential problem with this .. We initially build the documentation as the stable docs for the release, but then afterwards we copy those those docs into a subdirectory to keep them as older docs, at which point they are not the "stable" docs anymore ...

@AlenkaFAlenkaFOct 12, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, I have been thinking about this today and am getting very confused =D

@AlenkaFAlenkaFOct 16, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the switcher_version to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the versions.json.

Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊

@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, can we just include both entries in the json file? Both one with "" for the old docs, and one with the actual version for the stable docs, so something like:

 {
"name": "13.0 (stable)",
"version": "13.0.0/",
"url": "https://arrow.apache.org/docs/",
"preferred": true
},
{
"name": "13.0 (stable)",
"version": "",
"url": "https://arrow.apache.org/docs/",
},

?

@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although that would then give a duplicated entry in the dropdown, so also not ideal I suppose.

Another option would be to patch the doc sources when moving them from / to /xx.x when doing a release. It touches every file, but it's also a quite simple patch. A simple replacement of DOCUMENTATION_OPTIONS.theme_switcher_version_match = ''; with the correct version.

@AlenkaFAlenkaFOct 17, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in favour of the second approach (patch the doc sources when moving) 👍
So this PR can be merged as is, the patch can be added as a follow up after the release, right?

@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all, I would maybe just merge this PR as is, and then deal with the remaining issue discussed above to when we actually did a release, then it will be easier to experiment with this


html_theme_options = {
"show_toc_level": 2,
"use_edit_page_button": True,
Expand All@@ -313,7 +321,7 @@
"show_version_warning_banner": True,
"switcher": {
"json_url": "/docs/_static/versions.json",
"version_match": version,
"version_match": switcher_version,
},
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GH-38240: [Docs] version_match should match the version from versions.json by AlenkaF · Pull Request #38241 · apache/arrow · GitHub
Skip to content
GH-38240: [Docs] version_match should match the version from versions.json#38241

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

jorisvandenbossche
merged 3 commits into

from

Oct 17, 2023
 Merged


GH-38240: [Docs] version_match should match the version from versions.json
#38241
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
11bc973

Change version_match version


AlenkaF Oct 12, 2023
461841c

Use full versions.json url


AlenkaF Oct 12, 2023
26a6561

Revert json_url change


AlenkaF Oct 17, 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


10 changes: 9 additions & 1 deletion
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,6 +288,14 @@
# documentation.
#

switcher_version = version
if ".dev" in version:
 switcher_version = "dev/"
else:
 # If we are not building dev version of the docs, we are building
 # docs for the stable version
 switcher_version = ""
@jorisvandenbosschejorisvandenbosscheOct 12, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realize a potential problem with this .. We initially build the documentation as the stable docs for the release, but then afterwards we copy those those docs into a subdirectory to keep them as older docs, at which point they are not the "stable" docs anymore ...
@AlenkaFAlenkaFOct 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, I have been thinking about this today and am getting very confused =D
@AlenkaFAlenkaFOct 16, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the switcher_version to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the versions.json.
Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, can we just include both entries in the json file? Both one with "" for the old docs, and one with the actual version for the stable docs, so something like:
 {
"name": "13.0 (stable)",
"version": "13.0.0/",
"url": "https://arrow.apache.org/docs/",
"preferred": true
},
{
"name": "13.0 (stable)",
"version": "",
"url": "https://arrow.apache.org/docs/",
},

?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although that would then give a duplicated entry in the dropdown, so also not ideal I suppose.
Another option would be to patch the doc sources when moving them from / to /xx.x when doing a release. It touches every file, but it's also a quite simple patch. A simple replacement of DOCUMENTATION_OPTIONS.theme_switcher_version_match = ''; with the correct version.
@AlenkaFAlenkaFOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in favour of the second approach (patch the doc sources when moving) 👍

So this PR can be merged as is, the patch can be added as a follow up after the release, right?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all, I would maybe just merge this PR as is, and then deal with the remaining issue discussed above to when we actually did a release, then it will be easier to experiment with this

html_theme_options = {
 "show_toc_level": 2,
 "use_edit_page_button": True,
Expand All@@ -313,7 +321,7 @@
 "show_version_warning_banner": True,
 "switcher": {
 "json_url": "/docs/_static/versions.json",
 "version_match": version,
 "version_match": switcher_version,
 },
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GH-38240: [Docs] version_match should match the version from versions.json by AlenkaF · Pull Request #38241 · apache/arrow · GitHub
Skip to content
GH-38240: [Docs] version_match should match the version from versions.json#38241

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

jorisvandenbossche
merged 3 commits into

from

Oct 17, 2023
 Merged


GH-38240: [Docs] version_match should match the version from versions.json
#38241
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
11bc973

Change version_match version


AlenkaF Oct 12, 2023
461841c

Use full versions.json url


AlenkaF Oct 12, 2023
26a6561

Revert json_url change


AlenkaF Oct 17, 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


10 changes: 9 additions & 1 deletion
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,6 +288,14 @@
# documentation.
#

switcher_version = version
if ".dev" in version:
 switcher_version = "dev/"
else:
 # If we are not building dev version of the docs, we are building
 # docs for the stable version
 switcher_version = ""
@jorisvandenbosschejorisvandenbosscheOct 12, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realize a potential problem with this .. We initially build the documentation as the stable docs for the release, but then afterwards we copy those those docs into a subdirectory to keep them as older docs, at which point they are not the "stable" docs anymore ...
@AlenkaFAlenkaFOct 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, I have been thinking about this today and am getting very confused =D
@AlenkaFAlenkaFOct 16, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the switcher_version to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the versions.json.
Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, can we just include both entries in the json file? Both one with "" for the old docs, and one with the actual version for the stable docs, so something like:
 {
"name": "13.0 (stable)",
"version": "13.0.0/",
"url": "https://arrow.apache.org/docs/",
"preferred": true
},
{
"name": "13.0 (stable)",
"version": "",
"url": "https://arrow.apache.org/docs/",
},

?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although that would then give a duplicated entry in the dropdown, so also not ideal I suppose.
Another option would be to patch the doc sources when moving them from / to /xx.x when doing a release. It touches every file, but it's also a quite simple patch. A simple replacement of DOCUMENTATION_OPTIONS.theme_switcher_version_match = ''; with the correct version.
@AlenkaFAlenkaFOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in favour of the second approach (patch the doc sources when moving) 👍

So this PR can be merged as is, the patch can be added as a follow up after the release, right?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all, I would maybe just merge this PR as is, and then deal with the remaining issue discussed above to when we actually did a release, then it will be easier to experiment with this

html_theme_options = {
 "show_toc_level": 2,
 "use_edit_page_button": True,
Expand All@@ -313,7 +321,7 @@
 "show_version_warning_banner": True,
 "switcher": {
 "json_url": "/docs/_static/versions.json",
 "version_match": version,
 "version_match": switcher_version,
 },
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GH-38240: [Docs] version_match should match the version from versions.json by AlenkaF · Pull Request #38241 · apache/arrow · GitHub
Skip to content
GH-38240: [Docs] version_match should match the version from versions.json#38241

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

jorisvandenbossche
merged 3 commits into

from

Oct 17, 2023
 Merged


GH-38240: [Docs] version_match should match the version from versions.json
#38241
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
11bc973

Change version_match version


AlenkaF Oct 12, 2023
461841c

Use full versions.json url


AlenkaF Oct 12, 2023
26a6561

Revert json_url change


AlenkaF Oct 17, 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


10 changes: 9 additions & 1 deletion
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,6 +288,14 @@
# documentation.
#

switcher_version = version
if ".dev" in version:
 switcher_version = "dev/"
else:
 # If we are not building dev version of the docs, we are building
 # docs for the stable version
 switcher_version = ""
@jorisvandenbosschejorisvandenbosscheOct 12, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realize a potential problem with this .. We initially build the documentation as the stable docs for the release, but then afterwards we copy those those docs into a subdirectory to keep them as older docs, at which point they are not the "stable" docs anymore ...
@AlenkaFAlenkaFOct 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, I have been thinking about this today and am getting very confused =D
@AlenkaFAlenkaFOct 16, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the switcher_version to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the versions.json.
Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, can we just include both entries in the json file? Both one with "" for the old docs, and one with the actual version for the stable docs, so something like:
 {
"name": "13.0 (stable)",
"version": "13.0.0/",
"url": "https://arrow.apache.org/docs/",
"preferred": true
},
{
"name": "13.0 (stable)",
"version": "",
"url": "https://arrow.apache.org/docs/",
},

?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although that would then give a duplicated entry in the dropdown, so also not ideal I suppose.
Another option would be to patch the doc sources when moving them from / to /xx.x when doing a release. It touches every file, but it's also a quite simple patch. A simple replacement of DOCUMENTATION_OPTIONS.theme_switcher_version_match = ''; with the correct version.
@AlenkaFAlenkaFOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in favour of the second approach (patch the doc sources when moving) 👍

So this PR can be merged as is, the patch can be added as a follow up after the release, right?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all, I would maybe just merge this PR as is, and then deal with the remaining issue discussed above to when we actually did a release, then it will be easier to experiment with this

html_theme_options = {
 "show_toc_level": 2,
 "use_edit_page_button": True,
Expand All@@ -313,7 +321,7 @@
 "show_version_warning_banner": True,
 "switcher": {
 "json_url": "/docs/_static/versions.json",
 "version_match": version,
 "version_match": switcher_version,
 },
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
GH-38240: [Docs] version_match should match the version from versions.json by AlenkaF · Pull Request #38241 · apache/arrow · GitHub
Skip to content
GH-38240: [Docs] version_match should match the version from versions.json#38241

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

jorisvandenbossche
merged 3 commits into

from

Oct 17, 2023
 Merged


GH-38240: [Docs] version_match should match the version from versions.json
#38241
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
11bc973

Change version_match version


AlenkaF Oct 12, 2023
461841c

Use full versions.json url


AlenkaF Oct 12, 2023
26a6561

Revert json_url change


AlenkaF Oct 17, 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


10 changes: 9 additions & 1 deletion
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,6 +288,14 @@
# documentation.
#

switcher_version = version
if ".dev" in version:
 switcher_version = "dev/"
else:
 # If we are not building dev version of the docs, we are building
 # docs for the stable version
 switcher_version = ""
@jorisvandenbosschejorisvandenbosscheOct 12, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realize a potential problem with this .. We initially build the documentation as the stable docs for the release, but then afterwards we copy those those docs into a subdirectory to keep them as older docs, at which point they are not the "stable" docs anymore ...
@AlenkaFAlenkaFOct 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, I have been thinking about this today and am getting very confused =D
@AlenkaFAlenkaFOct 16, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the switcher_version to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the versions.json.
Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, can we just include both entries in the json file? Both one with "" for the old docs, and one with the actual version for the stable docs, so something like:
 {
"name": "13.0 (stable)",
"version": "13.0.0/",
"url": "https://arrow.apache.org/docs/",
"preferred": true
},
{
"name": "13.0 (stable)",
"version": "",
"url": "https://arrow.apache.org/docs/",
},

?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although that would then give a duplicated entry in the dropdown, so also not ideal I suppose.
Another option would be to patch the doc sources when moving them from / to /xx.x when doing a release. It touches every file, but it's also a quite simple patch. A simple replacement of DOCUMENTATION_OPTIONS.theme_switcher_version_match = ''; with the correct version.
@AlenkaFAlenkaFOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in favour of the second approach (patch the doc sources when moving) 👍

So this PR can be merged as is, the patch can be added as a follow up after the release, right?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all, I would maybe just merge this PR as is, and then deal with the remaining issue discussed above to when we actually did a release, then it will be easier to experiment with this

html_theme_options = {
 "show_toc_level": 2,
 "use_edit_page_button": True,
Expand All@@ -313,7 +321,7 @@
 "show_version_warning_banner": True,
 "switcher": {
 "json_url": "/docs/_static/versions.json",
 "version_match": version,
 "version_match": switcher_version,
 },
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GH-38240: [Docs] version_match should match the version from versions.json by AlenkaF · Pull Request #38241 · apache/arrow · GitHub
Skip to content
GH-38240: [Docs] version_match should match the version from versions.json#38241

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

jorisvandenbossche
merged 3 commits into

from

Oct 17, 2023
 Merged


GH-38240: [Docs] version_match should match the version from versions.json
#38241
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
11bc973

Change version_match version


AlenkaF Oct 12, 2023
461841c

Use full versions.json url


AlenkaF Oct 12, 2023
26a6561

Revert json_url change


AlenkaF Oct 17, 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


10 changes: 9 additions & 1 deletion
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,6 +288,14 @@
# documentation.
#

switcher_version = version
if ".dev" in version:
 switcher_version = "dev/"
else:
 # If we are not building dev version of the docs, we are building
 # docs for the stable version
 switcher_version = ""
@jorisvandenbosschejorisvandenbosscheOct 12, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realize a potential problem with this .. We initially build the documentation as the stable docs for the release, but then afterwards we copy those those docs into a subdirectory to keep them as older docs, at which point they are not the "stable" docs anymore ...
@AlenkaFAlenkaFOct 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, I have been thinking about this today and am getting very confused =D
@AlenkaFAlenkaFOct 16, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the switcher_version to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the versions.json.
Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, can we just include both entries in the json file? Both one with "" for the old docs, and one with the actual version for the stable docs, so something like:
 {
"name": "13.0 (stable)",
"version": "13.0.0/",
"url": "https://arrow.apache.org/docs/",
"preferred": true
},
{
"name": "13.0 (stable)",
"version": "",
"url": "https://arrow.apache.org/docs/",
},

?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although that would then give a duplicated entry in the dropdown, so also not ideal I suppose.
Another option would be to patch the doc sources when moving them from / to /xx.x when doing a release. It touches every file, but it's also a quite simple patch. A simple replacement of DOCUMENTATION_OPTIONS.theme_switcher_version_match = ''; with the correct version.
@AlenkaFAlenkaFOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in favour of the second approach (patch the doc sources when moving) 👍

So this PR can be merged as is, the patch can be added as a follow up after the release, right?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all, I would maybe just merge this PR as is, and then deal with the remaining issue discussed above to when we actually did a release, then it will be easier to experiment with this

html_theme_options = {
 "show_toc_level": 2,
 "use_edit_page_button": True,
Expand All@@ -313,7 +321,7 @@
 "show_version_warning_banner": True,
 "switcher": {
 "json_url": "/docs/_static/versions.json",
 "version_match": version,
 "version_match": switcher_version,
 },
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GH-38240: [Docs] version_match should match the version from versions.json by AlenkaF · Pull Request #38241 · apache/arrow · GitHub
Skip to content
GH-38240: [Docs] version_match should match the version from versions.json#38241

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

jorisvandenbossche
merged 3 commits into

from

Oct 17, 2023
 Merged


GH-38240: [Docs] version_match should match the version from versions.json
#38241
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
11bc973

Change version_match version


AlenkaF Oct 12, 2023
461841c

Use full versions.json url


AlenkaF Oct 12, 2023
26a6561

Revert json_url change


AlenkaF Oct 17, 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


10 changes: 9 additions & 1 deletion
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,6 +288,14 @@
# documentation.
#

switcher_version = version
if ".dev" in version:
 switcher_version = "dev/"
else:
 # If we are not building dev version of the docs, we are building
 # docs for the stable version
 switcher_version = ""
@jorisvandenbosschejorisvandenbosscheOct 12, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realize a potential problem with this .. We initially build the documentation as the stable docs for the release, but then afterwards we copy those those docs into a subdirectory to keep them as older docs, at which point they are not the "stable" docs anymore ...
@AlenkaFAlenkaFOct 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, I have been thinking about this today and am getting very confused =D
@AlenkaFAlenkaFOct 16, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the switcher_version to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the versions.json.
Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, can we just include both entries in the json file? Both one with "" for the old docs, and one with the actual version for the stable docs, so something like:
 {
"name": "13.0 (stable)",
"version": "13.0.0/",
"url": "https://arrow.apache.org/docs/",
"preferred": true
},
{
"name": "13.0 (stable)",
"version": "",
"url": "https://arrow.apache.org/docs/",
},

?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although that would then give a duplicated entry in the dropdown, so also not ideal I suppose.
Another option would be to patch the doc sources when moving them from / to /xx.x when doing a release. It touches every file, but it's also a quite simple patch. A simple replacement of DOCUMENTATION_OPTIONS.theme_switcher_version_match = ''; with the correct version.
@AlenkaFAlenkaFOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in favour of the second approach (patch the doc sources when moving) 👍

So this PR can be merged as is, the patch can be added as a follow up after the release, right?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all, I would maybe just merge this PR as is, and then deal with the remaining issue discussed above to when we actually did a release, then it will be easier to experiment with this

html_theme_options = {
 "show_toc_level": 2,
 "use_edit_page_button": True,
Expand All@@ -313,7 +321,7 @@
 "show_version_warning_banner": True,
 "switcher": {
 "json_url": "/docs/_static/versions.json",
 "version_match": version,
 "version_match": switcher_version,
 },
}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
GH-38240: [Docs] version_match should match the version from versions.json by AlenkaF · Pull Request #38241 · apache/arrow · GitHub
Skip to content
GH-38240: [Docs] version_match should match the version from versions.json#38241

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

jorisvandenbossche
merged 3 commits into

from

Oct 17, 2023
 Merged


GH-38240: [Docs] version_match should match the version from versions.json
#38241
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
11bc973

Change version_match version


AlenkaF Oct 12, 2023
461841c

Use full versions.json url


AlenkaF Oct 12, 2023
26a6561

Revert json_url change


AlenkaF Oct 17, 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


10 changes: 9 additions & 1 deletion
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -288,6 +288,14 @@
# documentation.
#

switcher_version = version
if ".dev" in version:
 switcher_version = "dev/"
else:
 # If we are not building dev version of the docs, we are building
 # docs for the stable version
 switcher_version = ""
@jorisvandenbosschejorisvandenbosscheOct 12, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realize a potential problem with this .. We initially build the documentation as the stable docs for the release, but then afterwards we copy those those docs into a subdirectory to keep them as older docs, at which point they are not the "stable" docs anymore ...
@AlenkaFAlenkaFOct 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, I have been thinking about this today and am getting very confused =D
@AlenkaFAlenkaFOct 16, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we will need to check for the numbered version of the docs here (13.0.0, 14.0.0, etc) and set the switcher_version to the number extracted from the version string (if not dev) so that once the docs get copied into the subdirectory will be correctly and equal to the version in the versions.json.
Then all the docs versions (old and dev), except stable, should have the correct text in the version switcher button. For the stable version - should we open a PR upstream to change the default text? 😊
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, can we just include both entries in the json file? Both one with "" for the old docs, and one with the actual version for the stable docs, so something like:
 {
"name": "13.0 (stable)",
"version": "13.0.0/",
"url": "https://arrow.apache.org/docs/",
"preferred": true
},
{
"name": "13.0 (stable)",
"version": "",
"url": "https://arrow.apache.org/docs/",
},

?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although that would then give a duplicated entry in the dropdown, so also not ideal I suppose.
Another option would be to patch the doc sources when moving them from / to /xx.x when doing a release. It touches every file, but it's also a quite simple patch. A simple replacement of DOCUMENTATION_OPTIONS.theme_switcher_version_match = ''; with the correct version.
@AlenkaFAlenkaFOct 17, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am in favour of the second approach (patch the doc sources when moving) 👍

So this PR can be merged as is, the patch can be added as a follow up after the release, right?
@jorisvandenbosschejorisvandenbosscheOct 17, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All in all, I would maybe just merge this PR as is, and then deal with the remaining issue discussed above to when we actually did a release, then it will be easier to experiment with this

html_theme_options = {
 "show_toc_level": 2,
 "use_edit_page_button": True,
Expand All@@ -313,7 +321,7 @@
 "show_version_warning_banner": True,
 "switcher": {
 "json_url": "/docs/_static/versions.json",
 "version_match": version,
 "version_match": switcher_version,
 },
}

Expand Down