ab41864f91
These are CSS/JavaScript changes changes to make navigation in the PySpark API a bit simpler by adding the following to the sidebar: * Classes * Functions * Tags to highlight experimental features  Online example here: https://dl.dropboxusercontent.com/u/20821334/pyspark-api-nav-enhance/pyspark.mllib.html (The contribution is my original work and that I license the work to the project under the project's open source license) Author: noelsmith <mail@noelsmith.com> Closes #8571 from noel-smith/pyspark-api-nav-enhance.
100 lines
3.4 KiB
JavaScript
100 lines
3.4 KiB
JavaScript
/*
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
(the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
$(function (){
|
|
|
|
function startsWith(s, prefix) {
|
|
return s && s.indexOf(prefix) === 0;
|
|
}
|
|
|
|
function buildSidebarLinkMap() {
|
|
var linkMap = {};
|
|
$('div.sphinxsidebar a.reference.internal').each(function (i,a) {
|
|
var href = $(a).attr('href');
|
|
if (startsWith(href, '#module-')) {
|
|
var id = href.substr(8);
|
|
linkMap[id] = [$(a), null];
|
|
}
|
|
})
|
|
return linkMap;
|
|
};
|
|
|
|
function getAdNoteDivs(dd) {
|
|
var noteDivs = {};
|
|
dd.find('> div.admonition.note > p.last').each(function (i, p) {
|
|
var text = $(p).text();
|
|
if (!noteDivs.experimental && startsWith(text, 'Experimental')) {
|
|
noteDivs.experimental = $(p).parent();
|
|
}
|
|
if (!noteDivs.deprecated && startsWith(text, 'Deprecated')) {
|
|
noteDivs.deprecated = $(p).parent();
|
|
}
|
|
});
|
|
return noteDivs;
|
|
}
|
|
|
|
function getParentId(name) {
|
|
var last_idx = name.lastIndexOf('.');
|
|
return last_idx == -1? '': name.substr(0, last_idx);
|
|
}
|
|
|
|
function buildTag(text, cls, tooltip) {
|
|
return '<span class="pys-tag ' + cls + ' hasTooltip">' + text + '<span class="tooltip">'
|
|
+ tooltip + '</span></span>'
|
|
}
|
|
|
|
|
|
var sidebarLinkMap = buildSidebarLinkMap();
|
|
|
|
$('dl.class, dl.function').each(function (i,dl) {
|
|
|
|
dl = $(dl);
|
|
dt = dl.children('dt').eq(0);
|
|
dd = dl.children('dd').eq(0);
|
|
var id = dt.attr('id');
|
|
var desc = dt.find('> .descname').text();
|
|
var adNoteDivs = getAdNoteDivs(dd);
|
|
|
|
if (id) {
|
|
var parent_id = getParentId(id);
|
|
|
|
var r = sidebarLinkMap[parent_id];
|
|
if (r) {
|
|
if (r[1] === null) {
|
|
r[1] = $('<ul/>');
|
|
r[0].parent().append(r[1]);
|
|
}
|
|
var tags = '';
|
|
if (adNoteDivs.experimental) {
|
|
tags += buildTag('E', 'pys-tag-experimental', 'Experimental');
|
|
adNoteDivs.experimental.addClass('pys-note pys-note-experimental');
|
|
}
|
|
if (adNoteDivs.deprecated) {
|
|
tags += buildTag('D', 'pys-tag-deprecated', 'Deprecated');
|
|
adNoteDivs.deprecated.addClass('pys-note pys-note-deprecated');
|
|
}
|
|
var li = $('<li/>');
|
|
var a = $('<a href="#' + id + '">' + desc + '</a>');
|
|
li.append(a);
|
|
li.append(tags);
|
|
r[1].append(li);
|
|
sidebarLinkMap[id] = [a, null];
|
|
}
|
|
}
|
|
});
|
|
});
|