diff --git a/readthedocs/core/static-src/core/js/doc-embed/search.js b/readthedocs/core/static-src/core/js/doc-embed/search.js index 619d7ee19e1..4e0574ee4d4 100644 --- a/readthedocs/core/static-src/core/js/doc-embed/search.js +++ b/readthedocs/core/static-src/core/js/doc-embed/search.js @@ -7,33 +7,6 @@ var xss = require('xss/lib/index'); var MAX_RESULT_PER_SECTION = 3; var MAX_SUBSTRING_LIMIT = 100; -/** - * Use try...catch block to append html to contents - * - * @param {Object} contents html element on which additional html is be appended - * @param {String} template underscore.js template string - * @param {Object} data template vars and their values - */ -function append_html_to_contents(contents, template, data) { - // underscore.js throws variable not defined error - // because of change of syntax in new versions. - // See: https://stackoverflow.com/a/25881231/8601393 - try { - // this is the pre-1.7 syntax from Underscore.js - contents.append( - $u.template( - template, - data - ) - ); - } - catch (error) { - // this is the new syntax - contents.append( - $u.template(template)(data) - ); - } -} /* * Search query override for hitting our local API instead of the standard @@ -50,7 +23,7 @@ function attach_elastic_search_query_sphinx(data) { var search_url = document.createElement('a'); search_url.href = data.proxied_api_host + '/api/v2/search/'; - search_url.search = '?q=' + $.urlencode(query) + '&project=' + project + + search_url.search = '?q=' + encodeURIComponent(query) + '&project=' + project + '&version=' + version + '&language=' + language; /* @@ -64,6 +37,42 @@ function attach_elastic_search_query_sphinx(data) { } }; + /** + * Build a section with its matching results. + * + * A section has the form: + * + *
+ * {title} + *
+ *
+ * {contents[0]} + *
+ *
+ * {contents[1]} + *
+ * + * ... + * + * @param {String} title. + * @param {String} link. + * @param {Array} contents. + */ + var buildSection = function (title, link, contents) { + var div_title = document.createElement("div"); + var a_element = document.createElement("a"); + a_element.href = link; + a_element.innerHTML = title; + div_title.appendChild(a_element); + html = div_title.outerHTML; + for (var i = 0; i < contents.length; i += 1) { + var div_content = document.createElement("div"); + div_content.innerHTML = contents[i]; + html += div_content.outerHTML; + } + return html; + }; + search_def .then(function (data) { var results = data.results || []; @@ -80,7 +89,7 @@ function attach_elastic_search_query_sphinx(data) { title = xss(result.highlights.title[0]); } - var link = result.path + "?highlight=" + $.urlencode(query); + var link = result.path + "?highlight=" + encodeURIComponent(query); var item = $('', {'href': link}); @@ -100,28 +109,6 @@ function attach_elastic_search_query_sphinx(data) { var contents = $('
'); - var section_template = - '
' + - '' + - '<%= section_subtitle %>' + - '' + - '
' + - '<% for (var i = 0; i < section_content.length; ++i) { %>' + - '
' + - '<%= section_content[i] %>' + - '
' + - '<% } %>'; - - var domain_template = - '
' + - '' + - '<%= domain_subtitle %>' + - '' + - '
' + - '
' + - '<%= domain_content %>' + - '
'; - // if the result is page section if (current_block.type === "section") { var section = current_block; @@ -145,15 +132,11 @@ function attach_elastic_search_query_sphinx(data) { } } - append_html_to_contents( - contents, - section_template, - { - section_subtitle_link: section_subtitle_link, - section_subtitle: section_subtitle, - section_content: section_content - } - ); + contents.append(buildSection( + section_subtitle, + section_subtitle_link, + section_content + )); } // if the result is a sphinx domain object @@ -178,15 +161,11 @@ function attach_elastic_search_query_sphinx(data) { var domain_subtitle = "[" + domain_role_name + "]: " + domain_name; - append_html_to_contents( - contents, - domain_template, - { - domain_subtitle_link: domain_subtitle_link, - domain_subtitle: domain_subtitle, - domain_content: domain_content - } - ); + contents.append(buildSection( + domain_subtitle, + domain_subtitle_link, + [domain_content] + )); } contents.find('span').addClass('highlighted'); diff --git a/readthedocs/core/static/core/js/readthedocs-doc-embed.js b/readthedocs/core/static/core/js/readthedocs-doc-embed.js index b0edb8491f4..edfead7f7f7 100644 --- a/readthedocs/core/static/core/js/readthedocs-doc-embed.js +++ b/readthedocs/core/static/core/js/readthedocs-doc-embed.js @@ -1 +1 @@ -!function n(r,o,a){function s(t,e){if(!o[t]){if(!r[t]){var i="function"==typeof require&&require;if(!e&&i)return i(t,!0);if(l)return l(t,!0);throw(e=new Error("Cannot find module '"+t+"'")).code="MODULE_NOT_FOUND",e}i=o[t]={exports:{}},r[t][0].call(i.exports,function(e){return s(r[t][1][e]||e)},i,i.exports,n,r,o,a)}return o[t].exports}for(var l="function"==typeof require&&require,e=0;e
"),i("table.docutils.footnote").wrap("
"),i("table.docutils.citation").wrap("
"),i(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var t=i(this);(expand=i('')).on("click",function(e){return n.toggleCurrent(t),e.stopPropagation(),!1}),t.prepend(expand)})},reset:function(){var e=encodeURI(window.location.hash)||"#";try{var t,i=$(".wy-menu-vertical"),n=i.find('[href="'+e+'"]');0===n.length&&(t=$('.document [id="'+e.substring(1)+'"]').closest("div.section"),0===(n=i.find('[href="#'+t.attr("id")+'"]')).length&&(n=i.find('[href="#"]'))),0this.docHeight||(this.navBar.scrollTop(i),this.winPosition=e)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(e){e=e.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:t.exports.ThemeNav,StickyNav:t.exports.ThemeNav});for(var o=0,r=["ms","moz","webkit","o"],a=0;a/g,u=/"/g,h=/"/g,p=/&#([a-zA-Z0-9]*);?/gim,g=/:?/gim,f=/&newline;?/gim,m=/((j\s*a\s*v\s*a|v\s*b|l\s*i\s*v\s*e)\s*s\s*c\s*r\s*i\s*p\s*t\s*|m\s*o\s*c\s*h\s*a)\:/gi,v=/e\s*x\s*p\s*r\s*e\s*s\s*s\s*i\s*o\s*n\s*\(.*/gi,b=/u\s*r\s*l\s*\(.*/gi;function w(e){return e.replace(u,""")}function y(e){return e.replace(h,'"')}function _(e){return e.replace(p,function(e,t){return"x"===t[0]||"X"===t[0]?String.fromCharCode(parseInt(t.substr(1),16)):String.fromCharCode(parseInt(t,10))})}function x(e){return e.replace(g,":").replace(f," ")}function k(e){for(var t="",i=0,n=e.length;i/g;i.whiteList=o(),i.getDefaultWhiteList=o,i.onTag=function(e,t,i){},i.onIgnoreTag=function(e,t,i){},i.onTagAttr=function(e,t,i){},i.onIgnoreTagAttr=function(e,t,i){},i.safeAttrValue=function(e,t,i,n){if(i=T(i),"href"===t||"src"===t){if("#"===(i=d.trim(i)))return"#";if("http://"!==i.substr(0,7)&&"https://"!==i.substr(0,8)&&"mailto:"!==i.substr(0,7)&&"tel:"!==i.substr(0,4)&&"#"!==i[0]&&"/"!==i[0])return""}else if("background"===t){if(m.lastIndex=0,m.test(i))return""}else if("style"===t){if(v.lastIndex=0,v.test(i))return"";if(b.lastIndex=0,b.test(i)&&(m.lastIndex=0,m.test(i)))return"";!1!==n&&(i=(n=n||a).process(i))}return i=E(i)},i.escapeHtml=s,i.escapeQuote=w,i.unescapeQuote=y,i.escapeHtmlEntities=_,i.escapeDangerHtml5Entities=x,i.clearNonPrintableCharacter=k,i.friendlyAttrValue=T,i.escapeAttrValue=E,i.onIgnoreTagStripAll=function(){return""},i.StripTagBody=function(o,a){"function"!=typeof a&&(a=function(){});var s=!Array.isArray(o),l=[],c=!1;return{onIgnoreTag:function(e,t,i){var n,r;return r=e,s||-1!==d.indexOf(o,r)?i.isClosing?(n=i.position+(r="[/removed]").length,l.push([!1!==c?c:i.position,n]),c=!1,r):(c=c||i.position,"[removed]"):a(e,t,i)},remove:function(t){var i="",n=0;return d.forEach(l,function(e){i+=t.slice(n,e[0]),n=e[1]}),i+=t.slice(n)}}},i.stripCommentTag=function(e){return e.replace(A,"")},i.stripBlankChar=function(e){return e.split("").filter(function(e){e=e.charCodeAt(0);return 127!==e&&(!(e<=31)||(10===e||13===e))}).join("")},i.cssFilter=a,i.getDefaultCSSWhiteList=r},{"./util":5,cssfilter:9}],3:[function(e,t,i){var n,r=e("./default"),o=e("./parser"),a=e("./xss");for(n in(i=t.exports=function(e,t){return new a(t).process(e)}).FilterXSS=a,r)i[n]=r[n];for(n in o)i[n]=o[n];"undefined"!=typeof window&&(window.filterXSS=t.exports)},{"./default":2,"./parser":4,"./xss":6}],4:[function(e,t,i){var g=e("./util");var d=/[^a-zA-Z0-9_:\.\-]/gim;function u(e){return'"'===(t=e)[0]&&'"'===t[t.length-1]||"'"===t[0]&&"'"===t[t.length-1]?e.substr(1,e.length-2):e;var t}i.parseTag=function(e,t,i){for(var n,r,o,a="",s=0,l=!1,c=!1,d=0,u=e.length,h="",d=0;d"===p?(a+=i(e.slice(s,l)),n=e.slice(l,d+1),r=n,o=void 0,o=g.spaceIndex(r),r=-1===o?r.slice(1,-1):r.slice(1,o+1),h=r="/"===(r="/"===(r=g.trim(r).toLowerCase()).slice(0,1)?r.slice(1):r).slice(-1)?r.slice(0,-1):r,a+=t(l,a.length,h,n,"";n=i;var n=-1===(a=m.spaceIndex(n))?{html:"",closing:"/"===n[n.length-2]}:{html:n=(a="/"===(n=m.trim(n.slice(a+1,-1)))[n.length-1])?m.trim(n.slice(0,-1)):n,closing:a},o=s[r],a=f(n.html,function(e,t){var i=-1!==m.indexOf(o,e),n=d(r,e,t,i);return v(n)?i?(t=h(r,e,t,g))?e+'="'+t+'"':e:v(n=u(r,e,t,i))?void 0:n:n}),i="<"+r;return a&&(i+=" "+a),n.closing&&(i+=" /"),i+=">"}return v(t=c(r,i,e))?p(i):t},p));return t=i?i.remove(t):t},t.exports=s},{"./default":2,"./parser":4,"./util":5,cssfilter:9}],7:[function(e,t,i){var n=e("./default"),r=e("./parser");e("./util");function u(e){return null==e}function o(e){(e=e||{}).whiteList=e.whiteList||n.whiteList,e.onAttr=e.onAttr||n.onAttr,e.onIgnoreAttr=e.onIgnoreAttr||n.onIgnoreAttr,this.options=e}o.prototype.process=function(e){if(!(e=(e=e||"").toString()))return"";var t=this.options,l=t.whiteList,c=t.onAttr,d=t.onIgnoreAttr;return r(e,function(e,t,i,n,r){var o,a=l[i],s=!1,a=(!0===a?s=a:"function"==typeof a?s=a(n):a instanceof RegExp&&(s=a.test(n)),{position:t,sourcePosition:e,source:r,isWhite:s=!0!==s?!1:s});return s?u(o=c(i,n,a))?i+":"+n:o:u(o=d(i,n,a))?void 0:o})},t.exports=o},{"./default":8,"./parser":10,"./util":11}],8:[function(e,t,i){function n(){var e={"align-content":!1,"align-items":!1,"align-self":!1,"alignment-adjust":!1,"alignment-baseline":!1,all:!1,"anchor-point":!1,animation:!1,"animation-delay":!1,"animation-direction":!1,"animation-duration":!1,"animation-fill-mode":!1,"animation-iteration-count":!1,"animation-name":!1,"animation-play-state":!1,"animation-timing-function":!1,azimuth:!1,"backface-visibility":!1,background:!0,"background-attachment":!0,"background-clip":!0,"background-color":!0,"background-image":!0,"background-origin":!0,"background-position":!0,"background-repeat":!0,"background-size":!0,"baseline-shift":!1,binding:!1,bleed:!1,"bookmark-label":!1,"bookmark-level":!1,"bookmark-state":!1,border:!0,"border-bottom":!0,"border-bottom-color":!0,"border-bottom-left-radius":!0,"border-bottom-right-radius":!0,"border-bottom-style":!0,"border-bottom-width":!0,"border-collapse":!0,"border-color":!0,"border-image":!0,"border-image-outset":!0,"border-image-repeat":!0,"border-image-slice":!0,"border-image-source":!0,"border-image-width":!0,"border-left":!0,"border-left-color":!0,"border-left-style":!0,"border-left-width":!0,"border-radius":!0,"border-right":!0,"border-right-color":!0,"border-right-style":!0,"border-right-width":!0,"border-spacing":!0,"border-style":!0,"border-top":!0,"border-top-color":!0,"border-top-left-radius":!0,"border-top-right-radius":!0,"border-top-style":!0,"border-top-width":!0,"border-width":!0,bottom:!1,"box-decoration-break":!0,"box-shadow":!0,"box-sizing":!0,"box-snap":!0,"box-suppress":!0,"break-after":!0,"break-before":!0,"break-inside":!0,"caption-side":!1,chains:!1,clear:!0,clip:!1,"clip-path":!1,"clip-rule":!1,color:!0,"color-interpolation-filters":!0,"column-count":!1,"column-fill":!1,"column-gap":!1,"column-rule":!1,"column-rule-color":!1,"column-rule-style":!1,"column-rule-width":!1,"column-span":!1,"column-width":!1,columns:!1,contain:!1,content:!1,"counter-increment":!1,"counter-reset":!1,"counter-set":!1,crop:!1,cue:!1,"cue-after":!1,"cue-before":!1,cursor:!1,direction:!1,display:!0,"display-inside":!0,"display-list":!0,"display-outside":!0,"dominant-baseline":!1,elevation:!1,"empty-cells":!1,filter:!1,flex:!1,"flex-basis":!1,"flex-direction":!1,"flex-flow":!1,"flex-grow":!1,"flex-shrink":!1,"flex-wrap":!1,float:!1,"float-offset":!1,"flood-color":!1,"flood-opacity":!1,"flow-from":!1,"flow-into":!1,font:!0,"font-family":!0,"font-feature-settings":!0,"font-kerning":!0,"font-language-override":!0,"font-size":!0,"font-size-adjust":!0,"font-stretch":!0,"font-style":!0,"font-synthesis":!0,"font-variant":!0,"font-variant-alternates":!0,"font-variant-caps":!0,"font-variant-east-asian":!0,"font-variant-ligatures":!0,"font-variant-numeric":!0,"font-variant-position":!0,"font-weight":!0,grid:!1,"grid-area":!1,"grid-auto-columns":!1,"grid-auto-flow":!1,"grid-auto-rows":!1,"grid-column":!1,"grid-column-end":!1,"grid-column-start":!1,"grid-row":!1,"grid-row-end":!1,"grid-row-start":!1,"grid-template":!1,"grid-template-areas":!1,"grid-template-columns":!1,"grid-template-rows":!1,"hanging-punctuation":!1,height:!0,hyphens:!1,icon:!1,"image-orientation":!1,"image-resolution":!1,"ime-mode":!1,"initial-letters":!1,"inline-box-align":!1,"justify-content":!1,"justify-items":!1,"justify-self":!1,left:!1,"letter-spacing":!0,"lighting-color":!0,"line-box-contain":!1,"line-break":!1,"line-grid":!1,"line-height":!1,"line-snap":!1,"line-stacking":!1,"line-stacking-ruby":!1,"line-stacking-shift":!1,"line-stacking-strategy":!1,"list-style":!0,"list-style-image":!0,"list-style-position":!0,"list-style-type":!0,margin:!0,"margin-bottom":!0,"margin-left":!0,"margin-right":!0,"margin-top":!0,"marker-offset":!1,"marker-side":!1,marks:!1,mask:!1,"mask-box":!1,"mask-box-outset":!1,"mask-box-repeat":!1,"mask-box-slice":!1,"mask-box-source":!1,"mask-box-width":!1,"mask-clip":!1,"mask-image":!1,"mask-origin":!1,"mask-position":!1,"mask-repeat":!1,"mask-size":!1,"mask-source-type":!1,"mask-type":!1,"max-height":!0,"max-lines":!1,"max-width":!0,"min-height":!0,"min-width":!0,"move-to":!1,"nav-down":!1,"nav-index":!1,"nav-left":!1,"nav-right":!1,"nav-up":!1,"object-fit":!1,"object-position":!1,opacity:!1,order:!1,orphans:!1,outline:!1,"outline-color":!1,"outline-offset":!1,"outline-style":!1,"outline-width":!1,overflow:!1,"overflow-wrap":!1,"overflow-x":!1,"overflow-y":!1,padding:!0,"padding-bottom":!0,"padding-left":!0,"padding-right":!0,"padding-top":!0,page:!1,"page-break-after":!1,"page-break-before":!1,"page-break-inside":!1,"page-policy":!1,pause:!1,"pause-after":!1,"pause-before":!1,perspective:!1,"perspective-origin":!1,pitch:!1,"pitch-range":!1,"play-during":!1,position:!1,"presentation-level":!1,quotes:!1,"region-fragment":!1,resize:!1,rest:!1,"rest-after":!1,"rest-before":!1,richness:!1,right:!1,rotation:!1,"rotation-point":!1,"ruby-align":!1,"ruby-merge":!1,"ruby-position":!1,"shape-image-threshold":!1,"shape-outside":!1,"shape-margin":!1,size:!1,speak:!1,"speak-as":!1,"speak-header":!1,"speak-numeral":!1,"speak-punctuation":!1,"speech-rate":!1,stress:!1,"string-set":!1,"tab-size":!1,"table-layout":!1,"text-align":!0,"text-align-last":!0,"text-combine-upright":!0,"text-decoration":!0,"text-decoration-color":!0,"text-decoration-line":!0,"text-decoration-skip":!0,"text-decoration-style":!0,"text-emphasis":!0,"text-emphasis-color":!0,"text-emphasis-position":!0,"text-emphasis-style":!0,"text-height":!0,"text-indent":!0,"text-justify":!0,"text-orientation":!0,"text-overflow":!0,"text-shadow":!0,"text-space-collapse":!0,"text-transform":!0,"text-underline-position":!0,"text-wrap":!0,top:!1,transform:!1,"transform-origin":!1,"transform-style":!1,transition:!1,"transition-delay":!1,"transition-duration":!1,"transition-property":!1,"transition-timing-function":!1,"unicode-bidi":!1,"vertical-align":!1,visibility:!1,"voice-balance":!1,"voice-duration":!1,"voice-family":!1,"voice-pitch":!1,"voice-range":!1,"voice-rate":!1,"voice-stress":!1,"voice-volume":!1,volume:!1,"white-space":!1,widows:!1,width:!0,"will-change":!1,"word-break":!0,"word-spacing":!0,"word-wrap":!0,"wrap-flow":!1,"wrap-through":!1,"writing-mode":!1,"z-index":!1};return e}i.whiteList=n(),i.getDefaultWhiteList=n,i.onAttr=function(e,t,i){},i.onIgnoreAttr=function(e,t,i){}},{}],9:[function(e,t,i){var n,r=e("./default"),o=e("./css");for(n in(i=t.exports=function(e,t){return new o(t).process(e)}).FilterCSS=o,r)i[n]=r[n];"undefined"!=typeof window&&(window.filterCSS=t.exports)},{"./css":7,"./default":8}],10:[function(e,t,i){var d=e("./util");t.exports=function(n,r){";"!==(n=d.trimRight(n))[n.length-1]&&(n+=";");var e=n.length,o=!1,a=0,s=0,l="";function t(){var e,t,i;o||-1!==(t=(e=d.trim(n.slice(a,s))).indexOf(":"))&&(i=d.trim(e.slice(0,t)),t=d.trim(e.slice(t+1)),i&&(i=r(a,l.length,i,t,e))&&(l+=i+"; ")),a=s+1}for(;s"),a=n.title,s=(n.highlights.title.length&&(a=k(n.highlights.title[0])),n.path+"?highlight="+$.urlencode(w)),l=$("",{href:s});l.html(a),l.find("span").addClass("highlighted"),o.append(l),n.project!==x&&(a=" (from project "+n.project_alias+")",l=$("",{text:a}),o.append(l));for(var c=0;c');if("section"===u.type){var p=u,g=p.title,f=s+"#"+p.id,m=[p.content.substr(0,E)+" ..."];if(p.highlights.title.length&&(g=k(p.highlights.title[0])),p.highlights.content.length)for(var v=p.highlights.content,m=[],b=0;b<%= section_subtitle %><% for (var i = 0; i < section_content.length; ++i) { %>
<%= section_content[i] %>
<% } %>',{section_subtitle_link:f,section_subtitle:g,section_content:m})}"domain"===u.type&&(f=(p=u).role,g=s+"#"+p.id,u=p.name,(d="")!==p.content&&(d=p.content.substr(0,E)+" ..."),p.highlights.content.length&&(d="... "+k(p.highlights.content[0])+" ..."),A(h,'
<%= domain_content %>
',{domain_subtitle_link:g,domain_subtitle:"["+f+"]: "+(u=p.highlights.name.length?k(p.highlights.name[0]):u),domain_content:d})),h.find("span").addClass("highlighted"),o.append(h),c"))}Search.output.jquery?Search.output.append(o):Search.output.appendChild(o.get(0))}y(Search.status,_("Search finished, found %s page(s) matching the search query.").replace("%s",t.length))}else console.log("Read the Docs search failed. Falling back to Sphinx search."),Search.query_fallback(w)}).fail(function(e){console.debug("Read the Docs search failed. Falling back to Sphinx search."),Search.query_fallback(w)}).always(function(){$("#search-progress").empty(),Search.stopPulse(),y(Search.title,_("Search Results"))}),$.ajax({url:e.href,crossDomain:!0,xhrFields:{withCredentials:!0},complete:function(e,t){return"success"!==t||void 0===e.responseJSON||0===e.responseJSON.count?n.reject():n.resolve(e.responseJSON)}}).fail(function(e,t,i){return n.reject()})}var i,x=t.project,r=t.version,o=t.language||"en";"undefined"!=typeof Search&&x&&r&&(t.features&&t.features.docsearch_disabled?console.log("Server side search is disabled."):(i=Search.query,Search.query_fallback=i,Search.query=e)),$(document).ready(function(){"undefined"!=typeof Search&&Search.init()})}function o(i){function b(){void 0!==window.doSearchFallback?window.doSearchFallback():console.log("Unable to fallback to original MkDocs search.")}function n(){var e=document.getElementById("mkdocs-search-query").value,n=$.Deferred(),t=document.createElement("a");t.href=i.proxied_api_host+"/api/v2/search/",t.search="?q="+encodeURIComponent(e)+"&project="+w+"&version="+r+"&language="+o,n.then(function(e){var t=e.results||[];if(t.length){var i=$("#mkdocs-search-results");i.empty();for(var n=0;n");s.append($("

").append($("",{href:a,text:r.title}))),r.project!==w&&(r="(from project "+r.project_alias+")",s.append($("",{text:r})));for(var l=0;lE?h.substr(0,E)+" ...":h];if(c.highlights.title.length&&(u=c.highlights.title[0]),c.highlights.content.length)for(var g=c.highlights.content,p=[],f=0;f/g,"").replace(/<\/span>/g,""),s.append($("

").append($("",{href:d}).html(u)));for(var m=0;m/g,"").replace(/<\/span>/g,"");s.append($("

").html(v))}i.append(s)}}}}else console.log("Read the Docs search returned 0 result. Falling back to MkDocs search."),b()}).fail(function(e){console.log("Read the Docs search failed. Falling back to MkDocs search."),b()}),$.ajax({url:t.href,crossDomain:!0,xhrFields:{withCredentials:!0},complete:function(e,t){return"success"!==t||void 0===e.responseJSON||0===e.responseJSON.count?n.reject():n.resolve(e.responseJSON)}}).fail(function(e,t,i){return n.reject()})}function e(){var e=document.getElementById("mkdocs-search-query"),t=(e&&e.addEventListener("keyup",n),window.getSearchTermFromLocation());t&&(e.value=t,n())}var w=i.project,r=i.version,o=i.language||"en";$(document).ready(function(){window.doSearchFallback=window.doSearch,window.doSearch=n,(window.initSearch=e)()})}t.exports={init:function(){var e=n.get();e.is_sphinx_builder()?r(e):e.features&&!e.features.docsearch_disabled?o(e):console.log("Server side search is disabled.")}}},{"./../../../../../../bower_components/xss/lib/index":3,"./rtd-data":14}],16:[function(n,e,t){var r=n("./rtd-data");e.exports={init:function(){var e,t,i=r.get();$(document).on("click","[data-toggle='rst-current-version']",function(){var e=$("[data-toggle='rst-versions']").hasClass("shift-up")?"was_open":"was_closed";"undefined"!=typeof READTHEDOCS_DATA&&READTHEDOCS_DATA.global_analytics_code&&("undefined"!=typeof gtag?gtag("event","Click",{event_category:"Flyout",event_label:e,send_to:"rtfd"}):"undefined"!=typeof ga?ga("rtfd.send","event","Flyout","Click",e):"undefined"!=typeof _gaq&&_gaq.push(["rtfd._setAccount","UA-17997319-1"],["rtfd._trackEvent","Flyout","Click",e]))}),void 0===window.SphinxRtdTheme&&(e=n("./../../../../../../bower_components/sphinx-rtd-theme/js/theme.js").ThemeNav,$(document).ready(function(){setTimeout(function(){e.navBar||e.enable()},1e3)}),i.is_rtd_like_theme()&&!$("div.wy-side-scroll:first").length&&(console.log("Applying theme sidebar fix..."),i=$("nav.wy-nav-side:first"),t=$("

").addClass("wy-side-scroll"),i.children().detach().appendTo(t),t.prependTo(i),e.navBar=t))}}},{"./../../../../../../bower_components/sphinx-rtd-theme/js/theme.js":1,"./rtd-data":14}],17:[function(e,t,i){e("./constants");var s,l=e("./rtd-data"),c="[data-ea-publisher]",d="#ethical-ad-placement";function u(){var e=!1;return $("
").attr("id","rtd-detection").attr("class","ethical-rtd").html(" ").appendTo("body"),0===$("#rtd-detection").height()&&(e=!0),$("#rtd-detection").remove(),e}function h(){console.log("---------------------------------------------------------------------------------------"),console.log("Read the Docs hosts documentation for tens of thousands of open source projects."),console.log("We fund our development (we are open source) and operations through advertising."),console.log("We promise to:"),console.log(" - never let advertisers run 3rd party JavaScript"),console.log(" - never sell user data to advertisers or other 3rd parties"),console.log(" - only show advertisements of interest to developers"),console.log("Read more about our approach to advertising here: https://docs.readthedocs.io/en/latest/advertising/ethical-advertising.html"),console.log("%cPlease allow our Ethical Ads or go ad-free:","font-size: 2em"),console.log("https://docs.readthedocs.io/en/latest/advertising/ad-blocking.html"),console.log("--------------------------------------------------------------------------------------")}function p(e){e&&(e=e.attr("class","keep-us-sustainable"),$("

").text("Support Read the Docs!").appendTo(e),$("

").html('Please help keep us sustainable by allowing our Ethical Ads in your ad blocker or go ad-free by subscribing.').appendTo(e),$("

").text("Thank you! ❤️").appendTo(e))}t.exports={init:function(){var t,e,i,n,r,o,a;(s=l.get()).show_promo()&&(r=null,o="readthedocs-sidebar",t=0<$(c).length?($(c).attr("data-ea-publisher","readthedocs"),$(c).attr("data-ea-manual","true"),"image"!==$(c).attr("data-ea-type")&&"text"!==$(c).attr("data-ea-type")&&$(c).attr("data-ea-type","readthedocs-sidebar"),$(c)):(0<$(d).length?(r=d,e=s.is_rtd_like_theme()?"ethical-rtd ethical-dark-theme":"ethical-alabaster"):s.is_mkdocs_builder()&&s.is_rtd_like_theme()?(r="nav.wy-nav-side",e="ethical-rtd ethical-dark-theme"):s.is_rtd_like_theme()?(r="nav.wy-nav-side > div.wy-side-scroll",e="ethical-rtd ethical-dark-theme"):s.is_alabaster_like_theme()&&(r="div.sphinxsidebar > div.sphinxsidebarwrapper",e="ethical-alabaster"),r?((!(a=(n=$("

").appendTo(r)).offset())||a.top-$(window).scrollTop()+200>$(window).height())&&(s.is_rtd_like_theme()?(r=$("
").insertAfter("footer hr"),e="ethical-rtd",Math.random()<=.25&&(i="stickybox",o="image")):s.is_alabaster_like_theme()&&(r="div.bodywrapper .body",e="ethical-alabaster")),n.remove(),$("
").attr("id","rtd-sidebar").attr("data-ea-publisher","readthedocs").attr("data-ea-type",o).attr("data-ea-manual","true").attr("data-ea-style",i).addClass(e).appendTo(r)):null),(a=document.createElement("script")).src="https://media.ethicalads.io/media/client/beta/ethicalads.min.js",a.type="text/javascript",a.async=!0,a.id="ethicaladsjs",document.getElementsByTagName("head")[0].appendChild(a),$.ajax({url:s.api_host+"/api/v2/sustainability/data/",crossDomain:!0,xhrFields:{withCredentials:!0},dataType:"jsonp",data:{format:"jsonp",project:s.project},success:function(e){t&&!e.ad_free&&(e.keywords&&t.attr("data-ea-keywords",e.keywords.join("|")),e.campaign_types&&t.attr("data-ea-campaign-types",e.campaign_types.join("|")),e.publisher&&t.attr("data-ea-publisher",e.publisher),"undefined"!=typeof ethicalads?ethicalads.load():!s.ad_free&&u()?(h(),p(t)):$("#ethicaladsjs").on("load",function(){"undefined"!=typeof ethicalads&ðicalads.load()}))},error:function(){console.error("Error loading Read the Docs user and project information"),!s.ad_free&&u()&&(h(),p(t))}}))}}},{"./constants":12,"./rtd-data":14}],18:[function(e,t,i){var a=e("./rtd-data");t.exports={init:function(e){var t=a.get();if(!e.is_highest)for(var t=window.location.pathname.replace(t.version,e.slug),i=$('

Note

You are not reading the most recent version of this documentation. is the latest version available.

'),n=(i.find("a").attr("href",t).text(e.slug),["[role=main]","main","div.body","div.document"]),r=0;r
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var t=n(this);(expand=n('')).on("click",function(e){return r.toggleCurrent(t),e.stopPropagation(),!1}),t.prepend(expand)})},reset:function(){var e=encodeURI(window.location.hash)||"#";try{var t,n=$(".wy-menu-vertical"),r=n.find('[href="'+e+'"]');0===r.length&&(t=$('.document [id="'+e.substring(1)+'"]').closest("div.section"),0===(r=n.find('[href="#'+t.attr("id")+'"]')).length&&(r=n.find('[href="#"]'))),0this.docHeight||(this.navBar.scrollTop(n),this.winPosition=e)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(e){e=e.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:t.exports.ThemeNav,StickyNav:t.exports.ThemeNav});for(var o=0,i=["ms","moz","webkit","o"],a=0;a/g,u=/"/g,h=/"/g,p=/&#([a-zA-Z0-9]*);?/gim,g=/:?/gim,f=/&newline;?/gim,m=/((j\s*a\s*v\s*a|v\s*b|l\s*i\s*v\s*e)\s*s\s*c\s*r\s*i\s*p\s*t\s*|m\s*o\s*c\s*h\s*a)\:/gi,v=/e\s*x\s*p\s*r\s*e\s*s\s*s\s*i\s*o\s*n\s*\(.*/gi,b=/u\s*r\s*l\s*\(.*/gi;function w(e){return e.replace(u,""")}function y(e){return e.replace(h,'"')}function _(e){return e.replace(p,function(e,t){return"x"===t[0]||"X"===t[0]?String.fromCharCode(parseInt(t.substr(1),16)):String.fromCharCode(parseInt(t,10))})}function x(e){return e.replace(g,":").replace(f," ")}function k(e){for(var t="",n=0,r=e.length;n/g;n.whiteList=o(),n.getDefaultWhiteList=o,n.onTag=function(e,t,n){},n.onIgnoreTag=function(e,t,n){},n.onTagAttr=function(e,t,n){},n.onIgnoreTagAttr=function(e,t,n){},n.safeAttrValue=function(e,t,n,r){if(n=T(n),"href"===t||"src"===t){if("#"===(n=d.trim(n)))return"#";if("http://"!==n.substr(0,7)&&"https://"!==n.substr(0,8)&&"mailto:"!==n.substr(0,7)&&"tel:"!==n.substr(0,4)&&"#"!==n[0]&&"/"!==n[0])return""}else if("background"===t){if(m.lastIndex=0,m.test(n))return""}else if("style"===t){if(v.lastIndex=0,v.test(n))return"";if(b.lastIndex=0,b.test(n)&&(m.lastIndex=0,m.test(n)))return"";!1!==r&&(n=(r=r||a).process(n))}return n=E(n)},n.escapeHtml=s,n.escapeQuote=w,n.unescapeQuote=y,n.escapeHtmlEntities=_,n.escapeDangerHtml5Entities=x,n.clearNonPrintableCharacter=k,n.friendlyAttrValue=T,n.escapeAttrValue=E,n.onIgnoreTagStripAll=function(){return""},n.StripTagBody=function(o,a){"function"!=typeof a&&(a=function(){});var s=!Array.isArray(o),l=[],c=!1;return{onIgnoreTag:function(e,t,n){var r,i;return i=e,s||-1!==d.indexOf(o,i)?n.isClosing?(r=n.position+(i="[/removed]").length,l.push([!1!==c?c:n.position,r]),c=!1,i):(c=c||n.position,"[removed]"):a(e,t,n)},remove:function(t){var n="",r=0;return d.forEach(l,function(e){n+=t.slice(r,e[0]),r=e[1]}),n+=t.slice(r)}}},n.stripCommentTag=function(e){return e.replace(A,"")},n.stripBlankChar=function(e){return e.split("").filter(function(e){e=e.charCodeAt(0);return 127!==e&&(!(e<=31)||(10===e||13===e))}).join("")},n.cssFilter=a,n.getDefaultCSSWhiteList=i},{"./util":5,cssfilter:9}],3:[function(e,t,n){var r,i=e("./default"),o=e("./parser"),a=e("./xss");for(r in(n=t.exports=function(e,t){return new a(t).process(e)}).FilterXSS=a,i)n[r]=i[r];for(r in o)n[r]=o[r];"undefined"!=typeof window&&(window.filterXSS=t.exports)},{"./default":2,"./parser":4,"./xss":6}],4:[function(e,t,n){var g=e("./util");var d=/[^a-zA-Z0-9_:\.\-]/gim;function u(e){return'"'===(t=e)[0]&&'"'===t[t.length-1]||"'"===t[0]&&"'"===t[t.length-1]?e.substr(1,e.length-2):e;var t}n.parseTag=function(e,t,n){for(var r,i,o,a="",s=0,l=!1,c=!1,d=0,u=e.length,h="",d=0;d"===p?(a+=n(e.slice(s,l)),r=e.slice(l,d+1),i=r,o=void 0,o=g.spaceIndex(i),i=-1===o?i.slice(1,-1):i.slice(1,o+1),h=i="/"===(i="/"===(i=g.trim(i).toLowerCase()).slice(0,1)?i.slice(1):i).slice(-1)?i.slice(0,-1):i,a+=t(l,a.length,h,r,"";r=n;var r=-1===(a=m.spaceIndex(r))?{html:"",closing:"/"===r[r.length-2]}:{html:r=(a="/"===(r=m.trim(r.slice(a+1,-1)))[r.length-1])?m.trim(r.slice(0,-1)):r,closing:a},o=s[i],a=f(r.html,function(e,t){var n=-1!==m.indexOf(o,e),r=d(i,e,t,n);return v(r)?n?(t=h(i,e,t,g))?e+'="'+t+'"':e:v(r=u(i,e,t,n))?void 0:r:r}),n="<"+i;return a&&(n+=" "+a),r.closing&&(n+=" /"),n+=">"}return v(t=c(i,n,e))?p(n):t},p));return t=n?n.remove(t):t},t.exports=s},{"./default":2,"./parser":4,"./util":5,cssfilter:9}],7:[function(e,t,n){var r=e("./default"),i=e("./parser");e("./util");function u(e){return null==e}function o(e){(e=e||{}).whiteList=e.whiteList||r.whiteList,e.onAttr=e.onAttr||r.onAttr,e.onIgnoreAttr=e.onIgnoreAttr||r.onIgnoreAttr,this.options=e}o.prototype.process=function(e){if(!(e=(e=e||"").toString()))return"";var t=this.options,l=t.whiteList,c=t.onAttr,d=t.onIgnoreAttr;return i(e,function(e,t,n,r,i){var o,a=l[n],s=!1,a=(!0===a?s=a:"function"==typeof a?s=a(r):a instanceof RegExp&&(s=a.test(r)),{position:t,sourcePosition:e,source:i,isWhite:s=!0!==s?!1:s});return s?u(o=c(n,r,a))?n+":"+r:o:u(o=d(n,r,a))?void 0:o})},t.exports=o},{"./default":8,"./parser":10,"./util":11}],8:[function(e,t,n){function r(){var e={"align-content":!1,"align-items":!1,"align-self":!1,"alignment-adjust":!1,"alignment-baseline":!1,all:!1,"anchor-point":!1,animation:!1,"animation-delay":!1,"animation-direction":!1,"animation-duration":!1,"animation-fill-mode":!1,"animation-iteration-count":!1,"animation-name":!1,"animation-play-state":!1,"animation-timing-function":!1,azimuth:!1,"backface-visibility":!1,background:!0,"background-attachment":!0,"background-clip":!0,"background-color":!0,"background-image":!0,"background-origin":!0,"background-position":!0,"background-repeat":!0,"background-size":!0,"baseline-shift":!1,binding:!1,bleed:!1,"bookmark-label":!1,"bookmark-level":!1,"bookmark-state":!1,border:!0,"border-bottom":!0,"border-bottom-color":!0,"border-bottom-left-radius":!0,"border-bottom-right-radius":!0,"border-bottom-style":!0,"border-bottom-width":!0,"border-collapse":!0,"border-color":!0,"border-image":!0,"border-image-outset":!0,"border-image-repeat":!0,"border-image-slice":!0,"border-image-source":!0,"border-image-width":!0,"border-left":!0,"border-left-color":!0,"border-left-style":!0,"border-left-width":!0,"border-radius":!0,"border-right":!0,"border-right-color":!0,"border-right-style":!0,"border-right-width":!0,"border-spacing":!0,"border-style":!0,"border-top":!0,"border-top-color":!0,"border-top-left-radius":!0,"border-top-right-radius":!0,"border-top-style":!0,"border-top-width":!0,"border-width":!0,bottom:!1,"box-decoration-break":!0,"box-shadow":!0,"box-sizing":!0,"box-snap":!0,"box-suppress":!0,"break-after":!0,"break-before":!0,"break-inside":!0,"caption-side":!1,chains:!1,clear:!0,clip:!1,"clip-path":!1,"clip-rule":!1,color:!0,"color-interpolation-filters":!0,"column-count":!1,"column-fill":!1,"column-gap":!1,"column-rule":!1,"column-rule-color":!1,"column-rule-style":!1,"column-rule-width":!1,"column-span":!1,"column-width":!1,columns:!1,contain:!1,content:!1,"counter-increment":!1,"counter-reset":!1,"counter-set":!1,crop:!1,cue:!1,"cue-after":!1,"cue-before":!1,cursor:!1,direction:!1,display:!0,"display-inside":!0,"display-list":!0,"display-outside":!0,"dominant-baseline":!1,elevation:!1,"empty-cells":!1,filter:!1,flex:!1,"flex-basis":!1,"flex-direction":!1,"flex-flow":!1,"flex-grow":!1,"flex-shrink":!1,"flex-wrap":!1,float:!1,"float-offset":!1,"flood-color":!1,"flood-opacity":!1,"flow-from":!1,"flow-into":!1,font:!0,"font-family":!0,"font-feature-settings":!0,"font-kerning":!0,"font-language-override":!0,"font-size":!0,"font-size-adjust":!0,"font-stretch":!0,"font-style":!0,"font-synthesis":!0,"font-variant":!0,"font-variant-alternates":!0,"font-variant-caps":!0,"font-variant-east-asian":!0,"font-variant-ligatures":!0,"font-variant-numeric":!0,"font-variant-position":!0,"font-weight":!0,grid:!1,"grid-area":!1,"grid-auto-columns":!1,"grid-auto-flow":!1,"grid-auto-rows":!1,"grid-column":!1,"grid-column-end":!1,"grid-column-start":!1,"grid-row":!1,"grid-row-end":!1,"grid-row-start":!1,"grid-template":!1,"grid-template-areas":!1,"grid-template-columns":!1,"grid-template-rows":!1,"hanging-punctuation":!1,height:!0,hyphens:!1,icon:!1,"image-orientation":!1,"image-resolution":!1,"ime-mode":!1,"initial-letters":!1,"inline-box-align":!1,"justify-content":!1,"justify-items":!1,"justify-self":!1,left:!1,"letter-spacing":!0,"lighting-color":!0,"line-box-contain":!1,"line-break":!1,"line-grid":!1,"line-height":!1,"line-snap":!1,"line-stacking":!1,"line-stacking-ruby":!1,"line-stacking-shift":!1,"line-stacking-strategy":!1,"list-style":!0,"list-style-image":!0,"list-style-position":!0,"list-style-type":!0,margin:!0,"margin-bottom":!0,"margin-left":!0,"margin-right":!0,"margin-top":!0,"marker-offset":!1,"marker-side":!1,marks:!1,mask:!1,"mask-box":!1,"mask-box-outset":!1,"mask-box-repeat":!1,"mask-box-slice":!1,"mask-box-source":!1,"mask-box-width":!1,"mask-clip":!1,"mask-image":!1,"mask-origin":!1,"mask-position":!1,"mask-repeat":!1,"mask-size":!1,"mask-source-type":!1,"mask-type":!1,"max-height":!0,"max-lines":!1,"max-width":!0,"min-height":!0,"min-width":!0,"move-to":!1,"nav-down":!1,"nav-index":!1,"nav-left":!1,"nav-right":!1,"nav-up":!1,"object-fit":!1,"object-position":!1,opacity:!1,order:!1,orphans:!1,outline:!1,"outline-color":!1,"outline-offset":!1,"outline-style":!1,"outline-width":!1,overflow:!1,"overflow-wrap":!1,"overflow-x":!1,"overflow-y":!1,padding:!0,"padding-bottom":!0,"padding-left":!0,"padding-right":!0,"padding-top":!0,page:!1,"page-break-after":!1,"page-break-before":!1,"page-break-inside":!1,"page-policy":!1,pause:!1,"pause-after":!1,"pause-before":!1,perspective:!1,"perspective-origin":!1,pitch:!1,"pitch-range":!1,"play-during":!1,position:!1,"presentation-level":!1,quotes:!1,"region-fragment":!1,resize:!1,rest:!1,"rest-after":!1,"rest-before":!1,richness:!1,right:!1,rotation:!1,"rotation-point":!1,"ruby-align":!1,"ruby-merge":!1,"ruby-position":!1,"shape-image-threshold":!1,"shape-outside":!1,"shape-margin":!1,size:!1,speak:!1,"speak-as":!1,"speak-header":!1,"speak-numeral":!1,"speak-punctuation":!1,"speech-rate":!1,stress:!1,"string-set":!1,"tab-size":!1,"table-layout":!1,"text-align":!0,"text-align-last":!0,"text-combine-upright":!0,"text-decoration":!0,"text-decoration-color":!0,"text-decoration-line":!0,"text-decoration-skip":!0,"text-decoration-style":!0,"text-emphasis":!0,"text-emphasis-color":!0,"text-emphasis-position":!0,"text-emphasis-style":!0,"text-height":!0,"text-indent":!0,"text-justify":!0,"text-orientation":!0,"text-overflow":!0,"text-shadow":!0,"text-space-collapse":!0,"text-transform":!0,"text-underline-position":!0,"text-wrap":!0,top:!1,transform:!1,"transform-origin":!1,"transform-style":!1,transition:!1,"transition-delay":!1,"transition-duration":!1,"transition-property":!1,"transition-timing-function":!1,"unicode-bidi":!1,"vertical-align":!1,visibility:!1,"voice-balance":!1,"voice-duration":!1,"voice-family":!1,"voice-pitch":!1,"voice-range":!1,"voice-rate":!1,"voice-stress":!1,"voice-volume":!1,volume:!1,"white-space":!1,widows:!1,width:!0,"will-change":!1,"word-break":!0,"word-spacing":!0,"word-wrap":!0,"wrap-flow":!1,"wrap-through":!1,"writing-mode":!1,"z-index":!1};return e}n.whiteList=r(),n.getDefaultWhiteList=r,n.onAttr=function(e,t,n){},n.onIgnoreAttr=function(e,t,n){}},{}],9:[function(e,t,n){var r,i=e("./default"),o=e("./css");for(r in(n=t.exports=function(e,t){return new o(t).process(e)}).FilterCSS=o,i)n[r]=i[r];"undefined"!=typeof window&&(window.filterCSS=t.exports)},{"./css":7,"./default":8}],10:[function(e,t,n){var d=e("./util");t.exports=function(r,i){";"!==(r=d.trimRight(r))[r.length-1]&&(r+=";");var e=r.length,o=!1,a=0,s=0,l="";function t(){var e,t,n;o||-1!==(t=(e=d.trim(r.slice(a,s))).indexOf(":"))&&(n=d.trim(e.slice(0,t)),t=d.trim(e.slice(t+1)),n&&(n=i(a,l.length,n,t,e))&&(l+=n+"; ")),a=s+1}for(;s"),a=r.title,s=(r.highlights.title.length&&(a=T(r.highlights.title[0])),r.path+"?highlight="+encodeURIComponent(w)),l=$("",{href:s});l.html(a),l.find("span").addClass("highlighted"),o.append(l),r.project!==k&&(a=" (from project "+r.project_alias+")",l=$("",{text:a}),o.append(l));for(var c=0;c');if("section"===u.type){var p=u,g=p.title,f=s+"#"+p.id,m=[p.content.substr(0,A)+" ..."];if(p.highlights.title.length&&(g=T(p.highlights.title[0])),p.highlights.content.length)for(var v=p.highlights.content,m=[],b=0;b
"))}Search.output.jquery?Search.output.append(o):Search.output.appendChild(o.get(0))}y(Search.status,_("Search finished, found %s page(s) matching the search query.").replace("%s",t.length))}else console.log("Read the Docs search failed. Falling back to Sphinx search."),Search.query_fallback(w)}).fail(function(e){console.debug("Read the Docs search failed. Falling back to Sphinx search."),Search.query_fallback(w)}).always(function(){$("#search-progress").empty(),Search.stopPulse(),y(Search.title,_("Search Results"))}),$.ajax({url:e.href,crossDomain:!0,xhrFields:{withCredentials:!0},complete:function(e,t){return"success"!==t||void 0===e.responseJSON||0===e.responseJSON.count?r.reject():r.resolve(e.responseJSON)}}).fail(function(e,t,n){return r.reject()})}var n,k=t.project,i=t.version,o=t.language||"en";"undefined"!=typeof Search&&k&&i&&(t.features&&t.features.docsearch_disabled?console.log("Server side search is disabled."):(n=Search.query,Search.query_fallback=n,Search.query=e)),$(document).ready(function(){"undefined"!=typeof Search&&Search.init()})}function o(n){function b(){void 0!==window.doSearchFallback?window.doSearchFallback():console.log("Unable to fallback to original MkDocs search.")}function r(){var e=document.getElementById("mkdocs-search-query").value,r=$.Deferred(),t=document.createElement("a");t.href=n.proxied_api_host+"/api/v2/search/",t.search="?q="+encodeURIComponent(e)+"&project="+w+"&version="+i+"&language="+o,r.then(function(e){var t=e.results||[];if(t.length){var n=$("#mkdocs-search-results");n.empty();for(var r=0;r");s.append($("

").append($("",{href:a,text:i.title}))),i.project!==w&&(i="(from project "+i.project_alias+")",s.append($("",{text:i})));for(var l=0;lA?h.substr(0,A)+" ...":h];if(c.highlights.title.length&&(u=c.highlights.title[0]),c.highlights.content.length)for(var g=c.highlights.content,p=[],f=0;f/g,"").replace(/<\/span>/g,""),s.append($("

").append($("",{href:d}).html(u)));for(var m=0;m/g,"").replace(/<\/span>/g,"");s.append($("

").html(v))}n.append(s)}}}}else console.log("Read the Docs search returned 0 result. Falling back to MkDocs search."),b()}).fail(function(e){console.log("Read the Docs search failed. Falling back to MkDocs search."),b()}),$.ajax({url:t.href,crossDomain:!0,xhrFields:{withCredentials:!0},complete:function(e,t){return"success"!==t||void 0===e.responseJSON||0===e.responseJSON.count?r.reject():r.resolve(e.responseJSON)}}).fail(function(e,t,n){return r.reject()})}function e(){var e=document.getElementById("mkdocs-search-query"),t=(e&&e.addEventListener("keyup",r),window.getSearchTermFromLocation());t&&(e.value=t,r())}var w=n.project,i=n.version,o=n.language||"en";$(document).ready(function(){window.doSearchFallback=window.doSearch,window.doSearch=r,(window.initSearch=e)()})}t.exports={init:function(){var e=r.get();e.is_sphinx_builder()?i(e):e.features&&!e.features.docsearch_disabled?o(e):console.log("Server side search is disabled.")}}},{"./../../../../../../bower_components/xss/lib/index":3,"./rtd-data":14}],16:[function(r,e,t){var i=r("./rtd-data");e.exports={init:function(){var e,t,n=i.get();$(document).on("click","[data-toggle='rst-current-version']",function(){var e=$("[data-toggle='rst-versions']").hasClass("shift-up")?"was_open":"was_closed";"undefined"!=typeof READTHEDOCS_DATA&&READTHEDOCS_DATA.global_analytics_code&&("undefined"!=typeof gtag?gtag("event","Click",{event_category:"Flyout",event_label:e,send_to:"rtfd"}):"undefined"!=typeof ga?ga("rtfd.send","event","Flyout","Click",e):"undefined"!=typeof _gaq&&_gaq.push(["rtfd._setAccount","UA-17997319-1"],["rtfd._trackEvent","Flyout","Click",e]))}),void 0===window.SphinxRtdTheme&&(e=r("./../../../../../../bower_components/sphinx-rtd-theme/js/theme.js").ThemeNav,$(document).ready(function(){setTimeout(function(){e.navBar||e.enable()},1e3)}),n.is_rtd_like_theme()&&!$("div.wy-side-scroll:first").length&&(console.log("Applying theme sidebar fix..."),n=$("nav.wy-nav-side:first"),t=$("

").addClass("wy-side-scroll"),n.children().detach().appendTo(t),t.prependTo(n),e.navBar=t))}}},{"./../../../../../../bower_components/sphinx-rtd-theme/js/theme.js":1,"./rtd-data":14}],17:[function(e,t,n){e("./constants");var s,l=e("./rtd-data"),c="[data-ea-publisher]",d="#ethical-ad-placement";function u(){var e=!1;return $("
").attr("id","rtd-detection").attr("class","ethical-rtd").html(" ").appendTo("body"),0===$("#rtd-detection").height()&&(e=!0),$("#rtd-detection").remove(),e}function h(){console.log("---------------------------------------------------------------------------------------"),console.log("Read the Docs hosts documentation for tens of thousands of open source projects."),console.log("We fund our development (we are open source) and operations through advertising."),console.log("We promise to:"),console.log(" - never let advertisers run 3rd party JavaScript"),console.log(" - never sell user data to advertisers or other 3rd parties"),console.log(" - only show advertisements of interest to developers"),console.log("Read more about our approach to advertising here: https://docs.readthedocs.io/en/latest/advertising/ethical-advertising.html"),console.log("%cPlease allow our Ethical Ads or go ad-free:","font-size: 2em"),console.log("https://docs.readthedocs.io/en/latest/advertising/ad-blocking.html"),console.log("--------------------------------------------------------------------------------------")}function p(e){e&&(e=e.attr("class","keep-us-sustainable"),$("

").text("Support Read the Docs!").appendTo(e),$("

").html('Please help keep us sustainable by allowing our Ethical Ads in your ad blocker or go ad-free by subscribing.').appendTo(e),$("

").text("Thank you! ❤️").appendTo(e))}t.exports={init:function(){var t,e,n,r,i,o,a;(s=l.get()).show_promo()&&(i=null,o="readthedocs-sidebar",t=0<$(c).length?($(c).attr("data-ea-publisher","readthedocs"),$(c).attr("data-ea-manual","true"),"image"!==$(c).attr("data-ea-type")&&"text"!==$(c).attr("data-ea-type")&&$(c).attr("data-ea-type","readthedocs-sidebar"),$(c)):(0<$(d).length?(i=d,e=s.is_rtd_like_theme()?"ethical-rtd ethical-dark-theme":"ethical-alabaster"):s.is_mkdocs_builder()&&s.is_rtd_like_theme()?(i="nav.wy-nav-side",e="ethical-rtd ethical-dark-theme"):s.is_rtd_like_theme()?(i="nav.wy-nav-side > div.wy-side-scroll",e="ethical-rtd ethical-dark-theme"):s.is_alabaster_like_theme()&&(i="div.sphinxsidebar > div.sphinxsidebarwrapper",e="ethical-alabaster"),i?((!(a=(r=$("

").appendTo(i)).offset())||a.top-$(window).scrollTop()+200>$(window).height())&&(s.is_rtd_like_theme()?(i=$("
").insertAfter("footer hr"),e="ethical-rtd",Math.random()<=.25&&(n="stickybox",o="image")):s.is_alabaster_like_theme()&&(i="div.bodywrapper .body",e="ethical-alabaster")),r.remove(),$("
").attr("id","rtd-sidebar").attr("data-ea-publisher","readthedocs").attr("data-ea-type",o).attr("data-ea-manual","true").attr("data-ea-style",n).addClass(e).appendTo(i)):null),(a=document.createElement("script")).src="https://media.ethicalads.io/media/client/beta/ethicalads.min.js",a.type="text/javascript",a.async=!0,a.id="ethicaladsjs",document.getElementsByTagName("head")[0].appendChild(a),$.ajax({url:s.api_host+"/api/v2/sustainability/data/",crossDomain:!0,xhrFields:{withCredentials:!0},dataType:"jsonp",data:{format:"jsonp",project:s.project},success:function(e){t&&!e.ad_free&&(e.keywords&&t.attr("data-ea-keywords",e.keywords.join("|")),e.campaign_types&&t.attr("data-ea-campaign-types",e.campaign_types.join("|")),e.publisher&&t.attr("data-ea-publisher",e.publisher),"undefined"!=typeof ethicalads?ethicalads.load():!s.ad_free&&u()?(h(),p(t)):$("#ethicaladsjs").on("load",function(){"undefined"!=typeof ethicalads&ðicalads.load()}))},error:function(){console.error("Error loading Read the Docs user and project information"),!s.ad_free&&u()&&(h(),p(t))}}))}}},{"./constants":12,"./rtd-data":14}],18:[function(e,t,n){var a=e("./rtd-data");t.exports={init:function(e){var t=a.get();if(!e.is_highest)for(var t=window.location.pathname.replace(t.version,e.slug),n=$('

Note

You are not reading the most recent version of this documentation. is the latest version available.

'),r=(n.find("a").attr("href",t).text(e.slug),["[role=main]","main","div.body","div.document"]),i=0;i