ARROW-14189: [Docs] Add version dropdown to the sphinx docs#11283

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

Closed
jorisvandenbossche wants to merge 4 commits into from
Closed

ARROW-14189: [Docs] Add version dropdown to the sphinx docs #11283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb10c3c
ARROW-14189: [Docs] Add version dropdown to the sphinx docs
jorisvandenbossche Oct 1, 2021
6ec1b98
update to latest upstream version
jorisvandenbossche Oct 26, 2021
502a39c
update to latest upstream version (use href) + use secondary color fo…
jorisvandenbossche Oct 27, 2021
c3dc3fc
update versions in json file to deal with version-less stable docs
jorisvandenbossche Oct 27, 2021
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
26 changes: 26 additions & 0 deletions docs/source/_static/versions.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
[
{
"name": "6.0 (stable)",
"version": ""
},
{
"name": "5.0",
"version": "5.0/"
},
{
"name": "4.0",
"version": "4.0/"
},
{
"name": "3.0",
"version": "3.0/"
},
{
"name": "2.0",
"version": "2.0/"
},
{
"name": "1.0",
"version": "1.0/"
}
]
2 changes: 2 additions & 0 deletions docs/source/_templates/docs-sidebar.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,8 @@
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

{% include "version-switcher.html" %}

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
Expand Down
60 changes: 60 additions & 0 deletions docs/source/_templates/version-switcher.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
<div class="dropdown">
<button type="button" class="btn btn-secondary btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
{{ release }}
<span class="caret"></span>
</button>
<div id="version_switcher" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>

<script type="text/javascript">
// Function to construct the target URL from the JSON components
function buildURL(entry) {
var template = "{{ switcher_template_url }}"; // supplied by jinja
template = template.replace("{version}", entry.version);
return template;
}

// Function to check if corresponding page path exists in other version of docs
// and, if so, go there instead of the homepage of the other docs version
function checkPageExistsAndRedirect(event) {
const currentFilePath = "{{ pagename }}.html",
otherDocsHomepage = event.target.getAttribute("href");
let tryUrl = `${otherDocsHomepage}${currentFilePath}`;
$.ajax({
type: 'HEAD',
url: tryUrl,
// if the page exists, go there
success: function() {
location.href = tryUrl;
}
}).fail(function() {
location.href = otherDocsHomepage;
});
return false;
}

// Function to populate the version switcher
(function () {
// get JSON config
$.getJSON("{{ switcher_json_url }}", function(data, textStatus, jqXHR) {
// create the nodes first (before AJAX calls) to ensure the order is
// correct (for now, links will go to doc version homepage)
$.each(data, function(index, entry) {
// if no custom name specified (e.g., "latest"), use version string
if (!("name" in entry)) {
entry.name = entry.version;
}
// construct the appropriate URL, and add it to the dropdown
entry.url = buildURL(entry);
const node = document.createElement("a");
node.setAttribute("class", "list-group-item list-group-item-action py-1");
node.setAttribute("href", `${entry.url}`);
node.textContent = `${entry.name}`;
node.onclick = checkPageExistsAndRedirect;
$("#version_switcher").append(node);
});
});
})();
</script>
10 changes: 10 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,9 @@
release = os.environ.get('ARROW_DOCS_VERSION',
pyarrow.__version__)

if "+" in release:
release = release.split(".dev")[0] + " (dev)"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand DownExpand Up@@ -196,6 +199,13 @@
"google_analytics_id": "UA-107500873-1",
}

html_context = {
"switcher_json_url": "/docs/_static/versions.json",
"switcher_template_url": "https://arrow.apache.org/docs/{version}",
# for local testing
# "switcher_template_url": "http://0.0.0.0:8000/docs/{version}",
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ARROW-14189: [Docs] Add version dropdown to the sphinx docs#11283

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

 Closed

jorisvandenbossche
wants to merge
4
commits into

from

 Closed


ARROW-14189: [Docs] Add version dropdown to the sphinx docs
#11283
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fb10c3c

ARROW-14189: [Docs] Add version dropdown to the sphinx docs


jorisvandenbossche Oct 1, 2021
6ec1b98

update to latest upstream version


jorisvandenbossche Oct 26, 2021
502a39c

update to latest upstream version (use href) + use secondary color fo…


jorisvandenbossche Oct 27, 2021
c3dc3fc

update versions in json file to deal with version-less stable docs


jorisvandenbossche Oct 27, 2021

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


26 changes: 26 additions & 0 deletions
docs/source/_static/versions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
[
 {
 "name": "6.0 (stable)",
 "version": ""
 },
 {
 "name": "5.0",
 "version": "5.0/"
 },
 {
 "name": "4.0",
 "version": "4.0/"
 },
 {
 "name": "3.0",
 "version": "3.0/"
 },
 {
 "name": "2.0",
 "version": "2.0/"
 },
 {
 "name": "1.0",
 "version": "1.0/"
 }
]

2 changes: 2 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,8 @@
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

{% include "version-switcher.html" %}

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
Expand Down

60 changes: 60 additions & 0 deletions
docs/source/_templates/version-switcher.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
<div class="dropdown">
 <button type="button" class="btn btn-secondary btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
 {{ release }}
 <span class="caret"></span>
 </button>
 <div id="version_switcher" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
 <!-- dropdown will be populated by javascript on page load -->
 </div>
</div>

<script type="text/javascript">
// Function to construct the target URL from the JSON components
function buildURL(entry) {
 var template = "{{ switcher_template_url }}"; // supplied by jinja
 template = template.replace("{version}", entry.version);
 return template;
}

// Function to check if corresponding page path exists in other version of docs
// and, if so, go there instead of the homepage of the other docs version
function checkPageExistsAndRedirect(event) {
 const currentFilePath = "{{ pagename }}.html",
 otherDocsHomepage = event.target.getAttribute("href");
 let tryUrl = `${otherDocsHomepage}${currentFilePath}`;
 $.ajax({
 type: 'HEAD',
 url: tryUrl,
 // if the page exists, go there
 success: function() {
 location.href = tryUrl;
 }
 }).fail(function() {
 location.href = otherDocsHomepage;
 });
 return false;
}

// Function to populate the version switcher
(function () {
 // get JSON config
 $.getJSON("{{ switcher_json_url }}", function(data, textStatus, jqXHR) {
 // create the nodes first (before AJAX calls) to ensure the order is
 // correct (for now, links will go to doc version homepage)
 $.each(data, function(index, entry) {
 // if no custom name specified (e.g., "latest"), use version string
 if (!("name" in entry)) {
 entry.name = entry.version;
 }
 // construct the appropriate URL, and add it to the dropdown
 entry.url = buildURL(entry);
 const node = document.createElement("a");
 node.setAttribute("class", "list-group-item list-group-item-action py-1");
 node.setAttribute("href", `${entry.url}`);
 node.textContent = `${entry.name}`;
 node.onclick = checkPageExistsAndRedirect;
 $("#version_switcher").append(node);
 });
 });
})();
</script>

10 changes: 10 additions & 0 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,9 @@
release = os.environ.get('ARROW_DOCS_VERSION',
 pyarrow.__version__)

if "+" in release:
 release = release.split(".dev")[0] + " (dev)"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand DownExpand Up@@ -196,6 +199,13 @@
 "google_analytics_id": "UA-107500873-1",
}

html_context = {
 "switcher_json_url": "/docs/_static/versions.json",
 "switcher_template_url": "https://arrow.apache.org/docs/{version}",
 # for local testing
 # "switcher_template_url": "http://0.0.0.0:8000/docs/{version}",
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-14189: [Docs] Add version dropdown to the sphinx docs#11283

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

 Closed

jorisvandenbossche
wants to merge
4
commits into

from

 Closed


ARROW-14189: [Docs] Add version dropdown to the sphinx docs
#11283
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fb10c3c

ARROW-14189: [Docs] Add version dropdown to the sphinx docs


jorisvandenbossche Oct 1, 2021
6ec1b98

update to latest upstream version


jorisvandenbossche Oct 26, 2021
502a39c

update to latest upstream version (use href) + use secondary color fo…


jorisvandenbossche Oct 27, 2021
c3dc3fc

update versions in json file to deal with version-less stable docs


jorisvandenbossche Oct 27, 2021

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


26 changes: 26 additions & 0 deletions
docs/source/_static/versions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
[
 {
 "name": "6.0 (stable)",
 "version": ""
 },
 {
 "name": "5.0",
 "version": "5.0/"
 },
 {
 "name": "4.0",
 "version": "4.0/"
 },
 {
 "name": "3.0",
 "version": "3.0/"
 },
 {
 "name": "2.0",
 "version": "2.0/"
 },
 {
 "name": "1.0",
 "version": "1.0/"
 }
]

2 changes: 2 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,8 @@
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

{% include "version-switcher.html" %}

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
Expand Down

60 changes: 60 additions & 0 deletions
docs/source/_templates/version-switcher.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
<div class="dropdown">
 <button type="button" class="btn btn-secondary btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
 {{ release }}
 <span class="caret"></span>
 </button>
 <div id="version_switcher" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
 <!-- dropdown will be populated by javascript on page load -->
 </div>
</div>

<script type="text/javascript">
// Function to construct the target URL from the JSON components
function buildURL(entry) {
 var template = "{{ switcher_template_url }}"; // supplied by jinja
 template = template.replace("{version}", entry.version);
 return template;
}

// Function to check if corresponding page path exists in other version of docs
// and, if so, go there instead of the homepage of the other docs version
function checkPageExistsAndRedirect(event) {
 const currentFilePath = "{{ pagename }}.html",
 otherDocsHomepage = event.target.getAttribute("href");
 let tryUrl = `${otherDocsHomepage}${currentFilePath}`;
 $.ajax({
 type: 'HEAD',
 url: tryUrl,
 // if the page exists, go there
 success: function() {
 location.href = tryUrl;
 }
 }).fail(function() {
 location.href = otherDocsHomepage;
 });
 return false;
}

// Function to populate the version switcher
(function () {
 // get JSON config
 $.getJSON("{{ switcher_json_url }}", function(data, textStatus, jqXHR) {
 // create the nodes first (before AJAX calls) to ensure the order is
 // correct (for now, links will go to doc version homepage)
 $.each(data, function(index, entry) {
 // if no custom name specified (e.g., "latest"), use version string
 if (!("name" in entry)) {
 entry.name = entry.version;
 }
 // construct the appropriate URL, and add it to the dropdown
 entry.url = buildURL(entry);
 const node = document.createElement("a");
 node.setAttribute("class", "list-group-item list-group-item-action py-1");
 node.setAttribute("href", `${entry.url}`);
 node.textContent = `${entry.name}`;
 node.onclick = checkPageExistsAndRedirect;
 $("#version_switcher").append(node);
 });
 });
})();
</script>

10 changes: 10 additions & 0 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,9 @@
release = os.environ.get('ARROW_DOCS_VERSION',
 pyarrow.__version__)

if "+" in release:
 release = release.split(".dev")[0] + " (dev)"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand DownExpand Up@@ -196,6 +199,13 @@
 "google_analytics_id": "UA-107500873-1",
}

html_context = {
 "switcher_json_url": "/docs/_static/versions.json",
 "switcher_template_url": "https://arrow.apache.org/docs/{version}",
 # for local testing
 # "switcher_template_url": "http://0.0.0.0:8000/docs/{version}",
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

Expand Down

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

Skip to content
ARROW-14189: [Docs] Add version dropdown to the sphinx docs#11283

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

 Closed

jorisvandenbossche
wants to merge
4
commits into

from

 Closed


ARROW-14189: [Docs] Add version dropdown to the sphinx docs
#11283
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fb10c3c

ARROW-14189: [Docs] Add version dropdown to the sphinx docs


jorisvandenbossche Oct 1, 2021
6ec1b98

update to latest upstream version


jorisvandenbossche Oct 26, 2021
502a39c

update to latest upstream version (use href) + use secondary color fo…


jorisvandenbossche Oct 27, 2021
c3dc3fc

update versions in json file to deal with version-less stable docs


jorisvandenbossche Oct 27, 2021

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


26 changes: 26 additions & 0 deletions
docs/source/_static/versions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
[
 {
 "name": "6.0 (stable)",
 "version": ""
 },
 {
 "name": "5.0",
 "version": "5.0/"
 },
 {
 "name": "4.0",
 "version": "4.0/"
 },
 {
 "name": "3.0",
 "version": "3.0/"
 },
 {
 "name": "2.0",
 "version": "2.0/"
 },
 {
 "name": "1.0",
 "version": "1.0/"
 }
]

2 changes: 2 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,8 @@
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

{% include "version-switcher.html" %}

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
Expand Down

60 changes: 60 additions & 0 deletions
docs/source/_templates/version-switcher.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
<div class="dropdown">
 <button type="button" class="btn btn-secondary btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
 {{ release }}
 <span class="caret"></span>
 </button>
 <div id="version_switcher" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
 <!-- dropdown will be populated by javascript on page load -->
 </div>
</div>

<script type="text/javascript">
// Function to construct the target URL from the JSON components
function buildURL(entry) {
 var template = "{{ switcher_template_url }}"; // supplied by jinja
 template = template.replace("{version}", entry.version);
 return template;
}

// Function to check if corresponding page path exists in other version of docs
// and, if so, go there instead of the homepage of the other docs version
function checkPageExistsAndRedirect(event) {
 const currentFilePath = "{{ pagename }}.html",
 otherDocsHomepage = event.target.getAttribute("href");
 let tryUrl = `${otherDocsHomepage}${currentFilePath}`;
 $.ajax({
 type: 'HEAD',
 url: tryUrl,
 // if the page exists, go there
 success: function() {
 location.href = tryUrl;
 }
 }).fail(function() {
 location.href = otherDocsHomepage;
 });
 return false;
}

// Function to populate the version switcher
(function () {
 // get JSON config
 $.getJSON("{{ switcher_json_url }}", function(data, textStatus, jqXHR) {
 // create the nodes first (before AJAX calls) to ensure the order is
 // correct (for now, links will go to doc version homepage)
 $.each(data, function(index, entry) {
 // if no custom name specified (e.g., "latest"), use version string
 if (!("name" in entry)) {
 entry.name = entry.version;
 }
 // construct the appropriate URL, and add it to the dropdown
 entry.url = buildURL(entry);
 const node = document.createElement("a");
 node.setAttribute("class", "list-group-item list-group-item-action py-1");
 node.setAttribute("href", `${entry.url}`);
 node.textContent = `${entry.name}`;
 node.onclick = checkPageExistsAndRedirect;
 $("#version_switcher").append(node);
 });
 });
})();
</script>

10 changes: 10 additions & 0 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,9 @@
release = os.environ.get('ARROW_DOCS_VERSION',
 pyarrow.__version__)

if "+" in release:
 release = release.split(".dev")[0] + " (dev)"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand DownExpand Up@@ -196,6 +199,13 @@
 "google_analytics_id": "UA-107500873-1",
}

html_context = {
 "switcher_json_url": "/docs/_static/versions.json",
 "switcher_template_url": "https://arrow.apache.org/docs/{version}",
 # for local testing
 # "switcher_template_url": "http://0.0.0.0:8000/docs/{version}",
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

Expand Down

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

Skip to content
ARROW-14189: [Docs] Add version dropdown to the sphinx docs#11283

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

 Closed

jorisvandenbossche
wants to merge
4
commits into

from

 Closed


ARROW-14189: [Docs] Add version dropdown to the sphinx docs
#11283
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fb10c3c

ARROW-14189: [Docs] Add version dropdown to the sphinx docs


jorisvandenbossche Oct 1, 2021
6ec1b98

update to latest upstream version


jorisvandenbossche Oct 26, 2021
502a39c

update to latest upstream version (use href) + use secondary color fo…


jorisvandenbossche Oct 27, 2021
c3dc3fc

update versions in json file to deal with version-less stable docs


jorisvandenbossche Oct 27, 2021

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


26 changes: 26 additions & 0 deletions
docs/source/_static/versions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
[
 {
 "name": "6.0 (stable)",
 "version": ""
 },
 {
 "name": "5.0",
 "version": "5.0/"
 },
 {
 "name": "4.0",
 "version": "4.0/"
 },
 {
 "name": "3.0",
 "version": "3.0/"
 },
 {
 "name": "2.0",
 "version": "2.0/"
 },
 {
 "name": "1.0",
 "version": "1.0/"
 }
]

2 changes: 2 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,8 @@
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

{% include "version-switcher.html" %}

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
Expand Down

60 changes: 60 additions & 0 deletions
docs/source/_templates/version-switcher.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
<div class="dropdown">
 <button type="button" class="btn btn-secondary btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
 {{ release }}
 <span class="caret"></span>
 </button>
 <div id="version_switcher" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
 <!-- dropdown will be populated by javascript on page load -->
 </div>
</div>

<script type="text/javascript">
// Function to construct the target URL from the JSON components
function buildURL(entry) {
 var template = "{{ switcher_template_url }}"; // supplied by jinja
 template = template.replace("{version}", entry.version);
 return template;
}

// Function to check if corresponding page path exists in other version of docs
// and, if so, go there instead of the homepage of the other docs version
function checkPageExistsAndRedirect(event) {
 const currentFilePath = "{{ pagename }}.html",
 otherDocsHomepage = event.target.getAttribute("href");
 let tryUrl = `${otherDocsHomepage}${currentFilePath}`;
 $.ajax({
 type: 'HEAD',
 url: tryUrl,
 // if the page exists, go there
 success: function() {
 location.href = tryUrl;
 }
 }).fail(function() {
 location.href = otherDocsHomepage;
 });
 return false;
}

// Function to populate the version switcher
(function () {
 // get JSON config
 $.getJSON("{{ switcher_json_url }}", function(data, textStatus, jqXHR) {
 // create the nodes first (before AJAX calls) to ensure the order is
 // correct (for now, links will go to doc version homepage)
 $.each(data, function(index, entry) {
 // if no custom name specified (e.g., "latest"), use version string
 if (!("name" in entry)) {
 entry.name = entry.version;
 }
 // construct the appropriate URL, and add it to the dropdown
 entry.url = buildURL(entry);
 const node = document.createElement("a");
 node.setAttribute("class", "list-group-item list-group-item-action py-1");
 node.setAttribute("href", `${entry.url}`);
 node.textContent = `${entry.name}`;
 node.onclick = checkPageExistsAndRedirect;
 $("#version_switcher").append(node);
 });
 });
})();
</script>

10 changes: 10 additions & 0 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,9 @@
release = os.environ.get('ARROW_DOCS_VERSION',
 pyarrow.__version__)

if "+" in release:
 release = release.split(".dev")[0] + " (dev)"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand DownExpand Up@@ -196,6 +199,13 @@
 "google_analytics_id": "UA-107500873-1",
}

html_context = {
 "switcher_json_url": "/docs/_static/versions.json",
 "switcher_template_url": "https://arrow.apache.org/docs/{version}",
 # for local testing
 # "switcher_template_url": "http://0.0.0.0:8000/docs/{version}",
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-14189: [Docs] Add version dropdown to the sphinx docs#11283

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

 Closed

jorisvandenbossche
wants to merge
4
commits into

from

 Closed


ARROW-14189: [Docs] Add version dropdown to the sphinx docs
#11283
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fb10c3c

ARROW-14189: [Docs] Add version dropdown to the sphinx docs


jorisvandenbossche Oct 1, 2021
6ec1b98

update to latest upstream version


jorisvandenbossche Oct 26, 2021
502a39c

update to latest upstream version (use href) + use secondary color fo…


jorisvandenbossche Oct 27, 2021
c3dc3fc

update versions in json file to deal with version-less stable docs


jorisvandenbossche Oct 27, 2021

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


26 changes: 26 additions & 0 deletions
docs/source/_static/versions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
[
 {
 "name": "6.0 (stable)",
 "version": ""
 },
 {
 "name": "5.0",
 "version": "5.0/"
 },
 {
 "name": "4.0",
 "version": "4.0/"
 },
 {
 "name": "3.0",
 "version": "3.0/"
 },
 {
 "name": "2.0",
 "version": "2.0/"
 },
 {
 "name": "1.0",
 "version": "1.0/"
 }
]

2 changes: 2 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,8 @@
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

{% include "version-switcher.html" %}

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
Expand Down

60 changes: 60 additions & 0 deletions
docs/source/_templates/version-switcher.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
<div class="dropdown">
 <button type="button" class="btn btn-secondary btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
 {{ release }}
 <span class="caret"></span>
 </button>
 <div id="version_switcher" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
 <!-- dropdown will be populated by javascript on page load -->
 </div>
</div>

<script type="text/javascript">
// Function to construct the target URL from the JSON components
function buildURL(entry) {
 var template = "{{ switcher_template_url }}"; // supplied by jinja
 template = template.replace("{version}", entry.version);
 return template;
}

// Function to check if corresponding page path exists in other version of docs
// and, if so, go there instead of the homepage of the other docs version
function checkPageExistsAndRedirect(event) {
 const currentFilePath = "{{ pagename }}.html",
 otherDocsHomepage = event.target.getAttribute("href");
 let tryUrl = `${otherDocsHomepage}${currentFilePath}`;
 $.ajax({
 type: 'HEAD',
 url: tryUrl,
 // if the page exists, go there
 success: function() {
 location.href = tryUrl;
 }
 }).fail(function() {
 location.href = otherDocsHomepage;
 });
 return false;
}

// Function to populate the version switcher
(function () {
 // get JSON config
 $.getJSON("{{ switcher_json_url }}", function(data, textStatus, jqXHR) {
 // create the nodes first (before AJAX calls) to ensure the order is
 // correct (for now, links will go to doc version homepage)
 $.each(data, function(index, entry) {
 // if no custom name specified (e.g., "latest"), use version string
 if (!("name" in entry)) {
 entry.name = entry.version;
 }
 // construct the appropriate URL, and add it to the dropdown
 entry.url = buildURL(entry);
 const node = document.createElement("a");
 node.setAttribute("class", "list-group-item list-group-item-action py-1");
 node.setAttribute("href", `${entry.url}`);
 node.textContent = `${entry.name}`;
 node.onclick = checkPageExistsAndRedirect;
 $("#version_switcher").append(node);
 });
 });
})();
</script>

10 changes: 10 additions & 0 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,9 @@
release = os.environ.get('ARROW_DOCS_VERSION',
 pyarrow.__version__)

if "+" in release:
 release = release.split(".dev")[0] + " (dev)"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand DownExpand Up@@ -196,6 +199,13 @@
 "google_analytics_id": "UA-107500873-1",
}

html_context = {
 "switcher_json_url": "/docs/_static/versions.json",
 "switcher_template_url": "https://arrow.apache.org/docs/{version}",
 # for local testing
 # "switcher_template_url": "http://0.0.0.0:8000/docs/{version}",
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ARROW-14189: [Docs] Add version dropdown to the sphinx docs#11283

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

 Closed

jorisvandenbossche
wants to merge
4
commits into

from

 Closed


ARROW-14189: [Docs] Add version dropdown to the sphinx docs
#11283
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fb10c3c

ARROW-14189: [Docs] Add version dropdown to the sphinx docs


jorisvandenbossche Oct 1, 2021
6ec1b98

update to latest upstream version


jorisvandenbossche Oct 26, 2021
502a39c

update to latest upstream version (use href) + use secondary color fo…


jorisvandenbossche Oct 27, 2021
c3dc3fc

update versions in json file to deal with version-less stable docs


jorisvandenbossche Oct 27, 2021

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


26 changes: 26 additions & 0 deletions
docs/source/_static/versions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
[
 {
 "name": "6.0 (stable)",
 "version": ""
 },
 {
 "name": "5.0",
 "version": "5.0/"
 },
 {
 "name": "4.0",
 "version": "4.0/"
 },
 {
 "name": "3.0",
 "version": "3.0/"
 },
 {
 "name": "2.0",
 "version": "2.0/"
 },
 {
 "name": "1.0",
 "version": "1.0/"
 }
]

2 changes: 2 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,8 @@
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

{% include "version-switcher.html" %}

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
Expand Down

60 changes: 60 additions & 0 deletions
docs/source/_templates/version-switcher.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
<div class="dropdown">
 <button type="button" class="btn btn-secondary btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
 {{ release }}
 <span class="caret"></span>
 </button>
 <div id="version_switcher" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
 <!-- dropdown will be populated by javascript on page load -->
 </div>
</div>

<script type="text/javascript">
// Function to construct the target URL from the JSON components
function buildURL(entry) {
 var template = "{{ switcher_template_url }}"; // supplied by jinja
 template = template.replace("{version}", entry.version);
 return template;
}

// Function to check if corresponding page path exists in other version of docs
// and, if so, go there instead of the homepage of the other docs version
function checkPageExistsAndRedirect(event) {
 const currentFilePath = "{{ pagename }}.html",
 otherDocsHomepage = event.target.getAttribute("href");
 let tryUrl = `${otherDocsHomepage}${currentFilePath}`;
 $.ajax({
 type: 'HEAD',
 url: tryUrl,
 // if the page exists, go there
 success: function() {
 location.href = tryUrl;
 }
 }).fail(function() {
 location.href = otherDocsHomepage;
 });
 return false;
}

// Function to populate the version switcher
(function () {
 // get JSON config
 $.getJSON("{{ switcher_json_url }}", function(data, textStatus, jqXHR) {
 // create the nodes first (before AJAX calls) to ensure the order is
 // correct (for now, links will go to doc version homepage)
 $.each(data, function(index, entry) {
 // if no custom name specified (e.g., "latest"), use version string
 if (!("name" in entry)) {
 entry.name = entry.version;
 }
 // construct the appropriate URL, and add it to the dropdown
 entry.url = buildURL(entry);
 const node = document.createElement("a");
 node.setAttribute("class", "list-group-item list-group-item-action py-1");
 node.setAttribute("href", `${entry.url}`);
 node.textContent = `${entry.name}`;
 node.onclick = checkPageExistsAndRedirect;
 $("#version_switcher").append(node);
 });
 });
})();
</script>

10 changes: 10 additions & 0 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,9 @@
release = os.environ.get('ARROW_DOCS_VERSION',
 pyarrow.__version__)

if "+" in release:
 release = release.split(".dev")[0] + " (dev)"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand DownExpand Up@@ -196,6 +199,13 @@
 "google_analytics_id": "UA-107500873-1",
}

html_context = {
 "switcher_json_url": "/docs/_static/versions.json",
 "switcher_template_url": "https://arrow.apache.org/docs/{version}",
 # for local testing
 # "switcher_template_url": "http://0.0.0.0:8000/docs/{version}",
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

Expand Down

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

Skip to content
ARROW-14189: [Docs] Add version dropdown to the sphinx docs#11283

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

 Closed

jorisvandenbossche
wants to merge
4
commits into

from

 Closed


ARROW-14189: [Docs] Add version dropdown to the sphinx docs
#11283
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
fb10c3c

ARROW-14189: [Docs] Add version dropdown to the sphinx docs


jorisvandenbossche Oct 1, 2021
6ec1b98

update to latest upstream version


jorisvandenbossche Oct 26, 2021
502a39c

update to latest upstream version (use href) + use secondary color fo…


jorisvandenbossche Oct 27, 2021
c3dc3fc

update versions in json file to deal with version-less stable docs


jorisvandenbossche Oct 27, 2021

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


26 changes: 26 additions & 0 deletions
docs/source/_static/versions.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
[
 {
 "name": "6.0 (stable)",
 "version": ""
 },
 {
 "name": "5.0",
 "version": "5.0/"
 },
 {
 "name": "4.0",
 "version": "4.0/"
 },
 {
 "name": "3.0",
 "version": "3.0/"
 },
 {
 "name": "2.0",
 "version": "2.0/"
 },
 {
 "name": "1.0",
 "version": "1.0/"
 }
]

2 changes: 2 additions & 0 deletions
docs/source/_templates/docs-sidebar.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,8 @@
 <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
</a>

{% include "version-switcher.html" %}

<form class="bd-search d-flex align-items-center" action="{{ pathto('search') }}" method="get">
 <i class="icon fas fa-search"></i>
 <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ theme_search_bar_text }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
Expand Down

60 changes: 60 additions & 0 deletions
docs/source/_templates/version-switcher.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
<div class="dropdown">
 <button type="button" class="btn btn-secondary btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
 {{ release }}
 <span class="caret"></span>
 </button>
 <div id="version_switcher" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
 <!-- dropdown will be populated by javascript on page load -->
 </div>
</div>

<script type="text/javascript">
// Function to construct the target URL from the JSON components
function buildURL(entry) {
 var template = "{{ switcher_template_url }}"; // supplied by jinja
 template = template.replace("{version}", entry.version);
 return template;
}

// Function to check if corresponding page path exists in other version of docs
// and, if so, go there instead of the homepage of the other docs version
function checkPageExistsAndRedirect(event) {
 const currentFilePath = "{{ pagename }}.html",
 otherDocsHomepage = event.target.getAttribute("href");
 let tryUrl = `${otherDocsHomepage}${currentFilePath}`;
 $.ajax({
 type: 'HEAD',
 url: tryUrl,
 // if the page exists, go there
 success: function() {
 location.href = tryUrl;
 }
 }).fail(function() {
 location.href = otherDocsHomepage;
 });
 return false;
}

// Function to populate the version switcher
(function () {
 // get JSON config
 $.getJSON("{{ switcher_json_url }}", function(data, textStatus, jqXHR) {
 // create the nodes first (before AJAX calls) to ensure the order is
 // correct (for now, links will go to doc version homepage)
 $.each(data, function(index, entry) {
 // if no custom name specified (e.g., "latest"), use version string
 if (!("name" in entry)) {
 entry.name = entry.version;
 }
 // construct the appropriate URL, and add it to the dropdown
 entry.url = buildURL(entry);
 const node = document.createElement("a");
 node.setAttribute("class", "list-group-item list-group-item-action py-1");
 node.setAttribute("href", `${entry.url}`);
 node.textContent = `${entry.name}`;
 node.onclick = checkPageExistsAndRedirect;
 $("#version_switcher").append(node);
 });
 });
})();
</script>

10 changes: 10 additions & 0 deletions
docs/source/conf.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,9 @@
release = os.environ.get('ARROW_DOCS_VERSION',
 pyarrow.__version__)

if "+" in release:
 release = release.split(".dev")[0] + " (dev)"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand DownExpand Up@@ -196,6 +199,13 @@
 "google_analytics_id": "UA-107500873-1",
}

html_context = {
 "switcher_json_url": "/docs/_static/versions.json",
 "switcher_template_url": "https://arrow.apache.org/docs/{version}",
 # for local testing
 # "switcher_template_url": "http://0.0.0.0:8000/docs/{version}",
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

Expand Down