/g,"").replace(/<\/span>/g,""),s.append($("").html(b))}i.append(s)}}}}else console.log("Read the Docs search returned 0 result. Falling back to MkDocs search."),w()}).fail(function(e){console.log("Read the Docs search failed. Falling back to MkDocs search."),w()}),$.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");e&&e.addEventListener("keyup",n);var t=window.getSearchTermFromLocation();t&&(e.value=t,n())}var y=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()?function(t){var A=t.project,i=t.version,r=t.language||"en";if("undefined"!=typeof Search&&A&&i)if(t.features&&t.features.docsearch_disabled)console.log("Server side search is disabled.");else{var e=Search.query;Search.query_fallback=e,Search.query=function(S){var n=$.Deferred(),e=document.createElement("a");e.href=t.proxied_api_host+"/api/v2/search/",e.search="?q="+$.urlencode(S)+"&project="+A+"&version="+i+"&language="+r,n.then(function(e){var t=e.results||[];if(t.length){for(var i=0;i'),a=n.title;n.highlights.title.length&&(a=C(n.highlights.title[0]));var s=n.path+"?highlight="+$.urlencode(S);n.path.startsWith("/projects/")&&!window.location.href.startsWith(n.domain)&&(s=n.domain+s);var l=$("",{href:s});if(l.html(a),l.find("span").addClass("highlighted"),o.append(l),n.project!==A){var c=" (from project "+n.project_alias+")",d=$("",{text:c});o.append(d)}for(var u=0;u');if("section"===h.type){var f=h,g=f.title,m=s+"#"+f.id,v=[f.content.substr(0,R)+" ..."];if(f.highlights.title.length&&(g=C(f.highlights.title[0])),f.highlights.content.length){var b=f.highlights.content;v=[];for(var w=0;w<%= section_subtitle %><% for (var i = 0; i < section_content.length; ++i) { %><%= section_content[i] %>
<% } %>',{section_subtitle_link:m,section_subtitle:g,section_content:v})}if("domain"===h.type){var y=h,x=y.role,k=s+"#"+y.id,T=y.name,E="";""!==y.content&&(E=y.content.substr(0,R)+" ..."),y.highlights.content.length&&(E="... "+C(y.highlights.content[0])+" ..."),y.highlights.name.length&&(T=C(y.highlights.name[0])),I(p,'<%= domain_content %>
',{domain_subtitle_link:k,domain_subtitle:"["+x+"]: "+T,domain_content:E})}p.find("span").addClass("highlighted"),o.append(p),u"))}Search.output.append(o),o.slideDown(5)}Search.status.text(_("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(S)}).fail(function(e){console.debug("Read the Docs search failed. Falling back to Sphinx search."),Search.query_fallback(S)}).always(function(){$("#search-progress").empty(),Search.stopPulse(),Search.title.text(_("Search Results")),Search.status.fadeIn(500)}),$.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()})}}$(document).ready(function(){"undefined"!=typeof Search&&Search.init()})}(e):e.features&&!e.features.docsearch_disabled?r(e):console.log("Server side search is disabled.")}}},{"./../../../../../../bower_components/xss/lib/index":3,"./rtd-data":14}],16:[function(r,e,t){var o=r("./rtd-data");e.exports={init:function(){var e=o.get();if($(document).on("click","[data-toggle='rst-current-version']",function(){var e=$("[data-toggle='rst-versions']").hasClass("shift-up")?"was_open":"was_closed";"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){var t=r("./../../../../../../bower_components/sphinx-rtd-theme/js/theme.js").ThemeNav;if($(document).ready(function(){setTimeout(function(){t.navBar||t.enable()},1e3)}),e.is_rtd_like_theme())if(!$("div.wy-side-scroll:first").length){console.log("Applying theme sidebar fix...");var i=$("nav.wy-nav-side:first"),n=$("").addClass("wy-side-scroll");i.children().detach().appendTo(n),n.prependTo(i),t.navBar=n}}}}},{"./../../../../../../bower_components/sphinx-rtd-theme/js/theme.js":1,"./rtd-data":14}],17:[function(e,t,i){e("./constants");var r,n=e("./rtd-data"),o="[data-ea-publisher]",a="#ethical-ad-placement";function s(){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 l(){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 c(e){var t=null;e&&(t=e.attr("class","keep-us-sustainable"),$("").text("Support Read the Docs!").appendTo(t),$("").html('Please help keep us sustainable by allowing our Ethical Ads in your ad blocker or go ad-free by subscribing.').appendTo(t),$("").text("Thank you! ❤️").appendTo(t))}t.exports={init:function(){var t;(r=n.get()).show_promo()&&(t=function(){var e,t,i,n=null;return 0<$(o).length?($(o).attr("data-ea-publisher","readthedocs"),$(o).attr("data-ea-manual","true"),"image"!==$(o).attr("data-ea-type")&&"text"!==$(o).attr("data-ea-type")&&$(o).attr("data-ea-type","readthedocs-sidebar"),$(o)):(0<$(a).length?(n=a,e=r.is_rtd_like_theme()?"ethical-rtd ethical-dark-theme":"ethical-alabaster"):r.is_mkdocs_builder()&&r.is_rtd_like_theme()?(n="nav.wy-nav-side",e="ethical-rtd ethical-dark-theme"):r.is_rtd_like_theme()?(n="nav.wy-nav-side > div.wy-side-scroll",e="ethical-rtd ethical-dark-theme"):r.is_alabaster_like_theme()&&(n="div.sphinxsidebar > div.sphinxsidebarwrapper",e="ethical-alabaster"),n?((!(i=(t=$("").appendTo(n)).offset())||i.top-$(window).scrollTop()+200>$(window).height())&&(r.is_rtd_like_theme()?(n=$("").insertAfter("footer hr"),e="ethical-rtd"):r.is_alabaster_like_theme()&&(n="div.bodywrapper .body",e="ethical-alabaster")),t.remove(),$("").attr("id","rtd-sidebar").attr("data-ea-publisher","readthedocs").attr("data-ea-type","readthedocs-sidebar").attr("data-ea-manual","true").addClass(e).appendTo(n)):null)}(),function(){var e=document.createElement("script");e.src="https://media.ethicalads.io/media/client/beta/ethicalads.min.js",e.type="text/javascript",e.async=!0,e.id="ethicaladsjs",document.getElementsByTagName("head")[0].appendChild(e)}(),$.ajax({url:r.api_host+"/api/v2/sustainability/data/",crossDomain:!0,xhrFields:{withCredentials:!0},dataType:"jsonp",data:{format:"jsonp",project:r.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():!r.ad_free&&s()?(l(),c(t)):$("#ethicaladsjs").on("load",function(){"undefined"!=typeof ethicalads&ðicalads.load()}))},error:function(){console.error("Error loading Read the Docs user and project information"),!r.ad_free&&s()&&(l(),c(t))}}))}}},{"./constants":12,"./rtd-data":14}],18:[function(e,t,i){var s=e("./rtd-data");t.exports={init:function(e){var t=s.get();if(!e.is_highest){var i=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.
');n.find("a").attr("href",i).text(e.slug);for(var r=["[role=main]","main","div.body","div.document"],o=0;o