diff --git a/docs/.buildinfo b/docs/.buildinfo index b24a453..ab85068 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9734b03eae06971efcfe1b6e87368659 +config: 7526424e177612b836e2e4929e4ee158 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_static/basic.css b/docs/_static/basic.css index 19ced10..104f076 100644 --- a/docs/_static/basic.css +++ b/docs/_static/basic.css @@ -81,6 +81,10 @@ div.sphinxsidebar input { font-size: 1em; } +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + div.sphinxsidebar #searchbox input[type="text"] { float: left; width: 80%; @@ -427,6 +431,13 @@ table.field-list td, table.field-list th { hyphens: manual; } +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist td { + vertical-align: top; +} + + /* -- other body styles ----------------------------------------------------- */ ol.arabic { diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js index 0c15c00..ffadbec 100644 --- a/docs/_static/doctools.js +++ b/docs/_static/doctools.js @@ -70,7 +70,9 @@ jQuery.fn.highlightText = function(text, className) { if (node.nodeType === 3) { var val = node.nodeValue; var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { var span; var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); if (isInSVG) { @@ -148,7 +150,9 @@ var Documentation = { this.fixFirefoxAnchorBug(); this.highlightSearchWords(); this.initIndexTable(); - + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } }, /** @@ -308,4 +312,4 @@ _ = Documentation.gettext; $(document).ready(function() { Documentation.init(); -}); \ No newline at end of file +}); diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 879857b..b0f2084 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,9 +1,296 @@ var DOCUMENTATION_OPTIONS = { - URL_ROOT: '', - VERSION: '0.6.5', + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '0.6.7', LANGUAGE: 'None', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt' -}; \ No newline at end of file + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SEARCH_LANGUAGE_STOP_WORDS: ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"] +}; + + + +/* Non-minified version JS is _stemmer.js if file is provided */ +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + + + + +var splitChars = (function() { + var result = {}; + var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, + 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, + 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, + 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, + 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, + 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, + 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, + 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, + 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, + 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; + var i, j, start, end; + for (i = 0; i < singles.length; i++) { + result[singles[i]] = true; + } + var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], + [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], + [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], + [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], + [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], + [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], + [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], + [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], + [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], + [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], + [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], + [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], + [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], + [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], + [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], + [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], + [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], + [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], + [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], + [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], + [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], + [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], + [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], + [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], + [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], + [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], + [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], + [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], + [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], + [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], + [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], + [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], + [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], + [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], + [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], + [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], + [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], + [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], + [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], + [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], + [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], + [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], + [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], + [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], + [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], + [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], + [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], + [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], + [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; + for (i = 0; i < ranges.length; i++) { + start = ranges[i][0]; + end = ranges[i][1]; + for (j = start; j <= end; j++) { + result[j] = true; + } + } + return result; +})(); + +function splitQuery(query) { + var result = []; + var start = -1; + for (var i = 0; i < query.length; i++) { + if (splitChars[query.charCodeAt(i)]) { + if (start !== -1) { + result.push(query.slice(start, i)); + start = -1; + } + } else if (start === -1) { + start = i; + } + } + if (start !== -1) { + result.push(query.slice(start)); + } + return result; +} + + diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index 41b8336..7473859 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -1,5 +1,5 @@ /* - * searchtools.js_t + * searchtools.js * ~~~~~~~~~~~~~~~~ * * Sphinx JavaScript utilities for the full-text search. @@ -9,323 +9,44 @@ * */ - -/* Non-minified version JS is _stemmer.js if file is provided */ -/** - * Porter Stemmer - */ -var Stemmer = function() { - - var step2list = { - ational: 'ate', - tional: 'tion', - enci: 'ence', - anci: 'ance', - izer: 'ize', - bli: 'ble', - alli: 'al', - entli: 'ent', - eli: 'e', - ousli: 'ous', - ization: 'ize', - ation: 'ate', - ator: 'ate', - alism: 'al', - iveness: 'ive', - fulness: 'ful', - ousness: 'ous', - aliti: 'al', - iviti: 'ive', - biliti: 'ble', - logi: 'log' - }; - - var step3list = { - icate: 'ic', - ative: '', - alize: 'al', - iciti: 'ic', - ical: 'ic', - ful: '', - ness: '' +if (!Scorer) { + /** + * Simple result scoring code. + */ + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [filename, title, anchor, descr, score] + // and returns the new score. + /* + score: function(result) { + return result[4]; + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: {0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5}, // used to be unimportantResults + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + // query found in terms + term: 5 }; - - var c = "[^aeiou]"; // consonant - var v = "[aeiouy]"; // vowel - var C = c + "[^aeiouy]*"; // consonant sequence - var V = v + "[aeiou]*"; // vowel sequence - - var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } } - - -/** - * Simple result scoring code. - */ -var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [filename, title, anchor, descr, score] - // and returns the new score. - /* - score: function(result) { - return result[4]; - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: {0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5}, // used to be unimportantResults - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - // query found in terms - term: 5 -}; - - - - - -var splitChars = (function() { - var result = {}; - var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, - 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, - 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, - 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, - 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, - 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, - 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, - 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, - 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, - 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; - var i, j, start, end; - for (i = 0; i < singles.length; i++) { - result[singles[i]] = true; - } - var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], - [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], - [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], - [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], - [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], - [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], - [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], - [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], - [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], - [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], - [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], - [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], - [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], - [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], - [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], - [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], - [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], - [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], - [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], - [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], - [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], - [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], - [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], - [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], - [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], - [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], - [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], - [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], - [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], - [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], - [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], - [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], - [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], - [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], - [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], - [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], - [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], - [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], - [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], - [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], - [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], - [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], - [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], - [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], - [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], - [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], - [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], - [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], - [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; - for (i = 0; i < ranges.length; i++) { - start = ranges[i][0]; - end = ranges[i][1]; - for (j = start; j <= end; j++) { - result[j] = true; - } - } - return result; -})(); - -function splitQuery(query) { - var result = []; - var start = -1; - for (var i = 0; i < query.length; i++) { - if (splitChars[query.charCodeAt(i)]) { - if (start !== -1) { - result.push(query.slice(start, i)); - start = -1; - } - } else if (start === -1) { - start = i; - } - } - if (start !== -1) { - result.push(query.slice(start)); - } - return result; +if (!splitQuery) { + function splitQuery(query) { + return query.split(/\s+/); + } } - - - /** * Search Module */ @@ -417,7 +138,7 @@ var Search = { */ query : function(query) { var i; - var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; + var stopwords = DOCUMENTATION_OPTIONS.SEARCH_LANGUAGE_STOP_WORDS; // stem the searchterms and add them to the correct list var stemmer = new Stemmer(); @@ -758,4 +479,4 @@ var Search = { $(document).ready(function() { Search.init(); -}); \ No newline at end of file +}); diff --git a/docs/api.html b/docs/api.html index d32a971..047620c 100644 --- a/docs/api.html +++ b/docs/api.html @@ -4,16 +4,15 @@ - API reference — libconfig 0.6.5 documentation + API reference — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -115,54 +114,63 @@ -check_option(*args, **kwargs) +check_option(key, subkey, value) Evaluate if a given value fits the option. document_options() -Generates a docstring table to add to the library documentation +Generates a docstring table to add to the library documentation. -get_option(*args, **kwargs) +get_option(key, subkey[, in_path_none]) Get the current value of the option. -get_option_default(*args, **kwargs) +get_option_default(key, subkey) Get the default value of the option. -get_option_description(*args, **kwargs) +get_option_description(key, subkey) Get the string descriving a particular option. -lock_option(*args, **kwargs) +lock_option(key, subkey) Make an option unmutable. -register_option(*args, **kwargs) +register_option(key, subkey, default, _type, …) Create a new option. -reset_option(*args, **kwargs) +reset_option(key, subkey) Resets a single option to the default values. reset_options([empty]) Empty ALL options. -set_option(*args, **kwargs) +set_option(key, subkey, value) Sets the value of an option. -set_options_from_JSON(filename) +set_options_from_file(filename[, format]) +Load options from file. + +set_options_from_JSON(filename) Load options from a YAML-formated file. -set_options_from_YAML(filename) +set_options_from_YAML(filename) Load options from a YAML-formated file. -set_options_from_dict(data_dict) +set_options_from_dict(data_dict) Load options from a dictionary. -show_options(*args, **kwargs) -Returns a copy the options DataFrame. +show_options([key]) +Returns a copy the options DataFrame. -write_options_to_JSON(filename) +write_options_to_JSON(filename) Writes the options in JSON format to a file. -write_options_to_YAML(filename) +write_options_to_YAML(filename) Writes the options in YAML format to a file. +get_local_config_file(filename) +Find local file to setup default values. + +on_option_value(*args) +Temporarily change the configuration values. +
@@ -185,7 +193,7 @@

© Copyright 2018, Jaume Bonet.
- Created using Sphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.check_option.html b/docs/generated/libconfig.check_option.html index 0cddfeb..ad33067 100644 --- a/docs/generated/libconfig.check_option.html +++ b/docs/generated/libconfig.check_option.html @@ -4,16 +4,15 @@ - libconfig.check_option — libconfig 0.6.5 documentation + libconfig.check_option — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,7 +105,7 @@

libconfig.check_option

-libconfig.check_option(*args, **kwargs)
+libconfig.check_option(key, subkey, value)

Evaluate if a given value fits the option.

If an option has a limited set of available values, check if the provided value is amongst them.

@@ -115,8 +114,8 @@

libconfig.check_option Parameters:
    -
  • key (str) – First identifier of the option.
    • -
  • subkey (str) – Second identifier of the option.
    • +
  • key (str) – First identifier of the option.
    • +
  • subkey (str) – Second identifier of the option.
  • value – Value to test (type varies).
@@ -160,7 +159,7 @@

libconfig.check_option

© Copyright 2018, Jaume Bonet.
- Created using Sphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.document_options.html b/docs/generated/libconfig.document_options.html index 7b82ff2..fed54ba 100644 --- a/docs/generated/libconfig.document_options.html +++ b/docs/generated/libconfig.document_options.html @@ -4,16 +4,15 @@ - libconfig.document_options — libconfig 0.6.5 documentation + libconfig.document_options — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -107,7 +106,7 @@

libconfig.document_options
libconfig.document_options()
-

Generates a docstring table to add to the library documentation

+

Generates a docstring table to add to the library documentation.

@@ -137,7 +136,7 @@

libconfig.document_optionsSphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.get_local_config_file.html b/docs/generated/libconfig.get_local_config_file.html new file mode 100644 index 0000000..100c37b --- /dev/null +++ b/docs/generated/libconfig.get_local_config_file.html @@ -0,0 +1,166 @@ + + + + + + + libconfig.get_local_config_file — libconfig 0.6.7 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+

libconfig.get_local_config_file

+
+
+libconfig.get_local_config_file(filename)
+

Find local file to setup default values.

+

There is a pre-fixed logic on how the search of the configuration +file is performed. If the highes priority configuration file is found, +there is no need to search for the next. From highest to lowest priority:

+
    +
  1. Local: Configuration file found in the current working directory.
    2. +
  2. Project: Configuration file found in the root of the current +working git repository.
    3. +
  3. User: Configuration file found in the user’s $HOME.
    4. +
+

+++ + + + + + +
Parameters:filename (str) – Raw name of the configuration file.
Returns:Union[str, None] - Configuration file with +the highest priority, None if no config file is found.
+
+ +

+ + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/generated/libconfig.get_option.html b/docs/generated/libconfig.get_option.html index dec0b10..0171211 100644 --- a/docs/generated/libconfig.get_option.html +++ b/docs/generated/libconfig.get_option.html @@ -4,16 +4,15 @@ - libconfig.get_option — libconfig 0.6.5 documentation + libconfig.get_option — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,15 +105,17 @@

libconfig.get_option

-libconfig.get_option(*args, **kwargs)
+libconfig.get_option(key, subkey, in_path_none=False)

Get the current value of the option.

@@ -127,6 +128,9 @@

libconfig.get_option

+ +
Parameters:
    -
  • key (str) – First identifier of the option.
    • -
  • subkey (str) – Second identifier of the option.
    • +
  • key (str) – First identifier of the option.
    • +
  • subkey (str) – Second identifier of the option.
    • +
  • in_path_none (bool) – Allows for in_path values of +None to be retrieved.
KeyError:If key or subkey do not define any option.
ValueError:If a in_path type with None value is +requested.
@@ -154,7 +158,7 @@

libconfig.get_option

© Copyright 2018, Jaume Bonet.
- Created using Sphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.get_option_default.html b/docs/generated/libconfig.get_option_default.html index 87fc4e0..87ae874 100644 --- a/docs/generated/libconfig.get_option_default.html +++ b/docs/generated/libconfig.get_option_default.html @@ -4,16 +4,15 @@ - libconfig.get_option_default — libconfig 0.6.5 documentation + libconfig.get_option_default — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,15 +105,15 @@

libconfig.get_option_default

-libconfig.get_option_default(*args, **kwargs)
+libconfig.get_option_default(key, subkey)

Get the default value of the option.

@@ -154,7 +153,7 @@

libconfig.get_option_defaultSphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.get_option_description.html b/docs/generated/libconfig.get_option_description.html index 4b66a75..2e1190e 100644 --- a/docs/generated/libconfig.get_option_description.html +++ b/docs/generated/libconfig.get_option_description.html @@ -4,16 +4,15 @@ - libconfig.get_option_description — libconfig 0.6.5 documentation + libconfig.get_option_description — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,15 +105,15 @@

libconfig.get_option_description

-libconfig.get_option_description(*args, **kwargs)
+libconfig.get_option_description(key, subkey)

Get the string descriving a particular option.

Parameters:
    -
  • key (str) – First identifier of the option.
    • -
  • subkey (str) – Second identifier of the option.
    • +
  • key (str) – First identifier of the option.
    • +
  • subkey (str) – Second identifier of the option.
@@ -154,7 +153,7 @@

libconfig.get_option_descriptionSphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.lock_option.html b/docs/generated/libconfig.lock_option.html index 022060f..5480fa8 100644 --- a/docs/generated/libconfig.lock_option.html +++ b/docs/generated/libconfig.lock_option.html @@ -4,16 +4,15 @@ - libconfig.lock_option — libconfig 0.6.5 documentation + libconfig.lock_option — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,15 +105,15 @@

libconfig.lock_option

-libconfig.lock_option(*args, **kwargs)
+libconfig.lock_option(key, subkey)

Make an option unmutable.

Parameters:
    -
  • key (str) – First identifier of the option.
    • -
  • subkey (str) – Second identifier of the option.
    • +
  • key (str) – First identifier of the option.
    • +
  • subkey (str) – Second identifier of the option.
@@ -151,7 +150,7 @@

libconfig.lock_option

© Copyright 2018, Jaume Bonet.
- Created using Sphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.on_option_value.html b/docs/generated/libconfig.on_option_value.html new file mode 100644 index 0000000..dfa57a2 --- /dev/null +++ b/docs/generated/libconfig.on_option_value.html @@ -0,0 +1,186 @@ + + + + + + + libconfig.on_option_value — libconfig 0.6.7 documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+

libconfig.on_option_value

+
+
+class libconfig.on_option_value(*args)
+

Temporarily change the configuration values.

+

Parameters:
    -
  • key (str) – First identifier of the option.
    • -
  • subkey (str) – Second identifier of the option.
    • +
  • key (str) – First identifier of the option.
    • +
  • subkey (str) – Second identifier of the option.
+++ + + + +
Raises: +++ + + + +
ValueError:If the number of parameters cannot be casted into +one or multiple options.
+
+
In [1]: import libconfig as cfg
+   ...: cfg.register_option('opt', 'one', 1, 'int', 'option 1')
+   ...: cfg.register_option('opt', 'two', 2, 'int', 'option 2')
+   ...: print(cfg.get_option('opt', 'one'))
+   ...: with cfg.on_option_value('opt', 'one', 10):
+   ...:     print(cfg.get_option('opt', 'one'))
+   ...: print(cfg.get_option('opt', 'one'))
+   ...: print(cfg.get_option('opt', 'two'))
+   ...: with cfg.on_option_value('opt', 'one', 10, 'opt', 'two', 20):
+   ...:     print(cfg.get_option('opt', 'one'))
+   ...:     print(cfg.get_option('opt', 'two'))
+   ...: print(cfg.get_option('opt', 'one'))
+   ...: print(cfg.get_option('opt', 'two'))
+   ...: 
+1
+10
+1
+2
+10
+20
+1
+2
+
+
+
+ +
+ + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/generated/libconfig.register_option.html b/docs/generated/libconfig.register_option.html index 065881e..a8ab3de 100644 --- a/docs/generated/libconfig.register_option.html +++ b/docs/generated/libconfig.register_option.html @@ -4,16 +4,15 @@ - libconfig.register_option — libconfig 0.6.5 documentation + libconfig.register_option — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,23 +105,23 @@

libconfig.register_option

-libconfig.register_option(*args, **kwargs)
+libconfig.register_option(key, subkey, default, _type, definition, values=None, locked=False)

Create a new option.

@@ -159,7 +158,7 @@

libconfig.register_optionSphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.reset_option.html b/docs/generated/libconfig.reset_option.html index 2283af2..e5ed06e 100644 --- a/docs/generated/libconfig.reset_option.html +++ b/docs/generated/libconfig.reset_option.html @@ -4,16 +4,15 @@ - libconfig.reset_option — libconfig 0.6.5 documentation + libconfig.reset_option — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,15 +105,15 @@

libconfig.reset_option

-libconfig.reset_option(*args, **kwargs)
+libconfig.reset_option(key, subkey)

Resets a single option to the default values.

Parameters:
    -
  • key (str) – First identifier of the option.
    • -
  • subkey (str) – Second identifier of the option.
    • +
  • key (str) – First identifier of the option.
    • +
  • subkey (str) – Second identifier of the option.
  • default – Default value of the option. Type varies and it is described by _type.
    • -
  • _type (str) – Type of the value of the option. Available options are: +
  • _type (str) – Type of the value of the option. Available options are: [int, float, bool, text, string, path_in, path_out].
  • definition (str) – Brief explanation of the option.
  • values (list() of accepted _type) – Available values for the option.
    • -
  • locked (bool) – If True, option cannot be altered.
    • +
  • locked (bool) – If True, option cannot be altered.
@@ -153,7 +152,7 @@

libconfig.reset_option

© Copyright 2018, Jaume Bonet.
- Created using Sphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.reset_options.html b/docs/generated/libconfig.reset_options.html index b6edc46..88d0ceb 100644 --- a/docs/generated/libconfig.reset_options.html +++ b/docs/generated/libconfig.reset_options.html @@ -4,16 +4,15 @@ - libconfig.reset_options — libconfig 0.6.5 documentation + libconfig.reset_options — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -112,8 +111,8 @@

libconfig.reset_options

- +
Parameters:
    -
  • key (str) – First identifier of the option.
    • -
  • subkey (str) – Second identifier of the option.
    • +
  • key (str) – First identifier of the option.
    • +
  • subkey (str) – Second identifier of the option.
Parameters:empty (bool) – When True, completelly removes all options; when -False, sets them back to its original value.
Parameters:empty (bool) – When True, completelly removes all options; +when False, sets them back to its original value.
@@ -139,7 +138,7 @@

libconfig.reset_options

© Copyright 2018, Jaume Bonet.
- Created using Sphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.set_option.html b/docs/generated/libconfig.set_option.html index 218596d..812f429 100644 --- a/docs/generated/libconfig.set_option.html +++ b/docs/generated/libconfig.set_option.html @@ -4,23 +4,22 @@ - libconfig.set_option — libconfig 0.6.5 documentation + libconfig.set_option — libconfig 0.6.7 documentation - - + + - - + @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,15 +105,15 @@

libconfig.set_option

-libconfig.set_option(*args, **kwargs)
+libconfig.set_option(key, subkey, value)

Sets the value of an option.

@@ -160,7 +159,7 @@

libconfig.set_option

© Copyright 2018, Jaume Bonet.
- Created using Sphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.set_options_from_JSON.html b/docs/generated/libconfig.set_options_from_JSON.html index ffb27b6..8623595 100644 --- a/docs/generated/libconfig.set_options_from_JSON.html +++ b/docs/generated/libconfig.set_options_from_JSON.html @@ -4,16 +4,15 @@ - libconfig.set_options_from_JSON — libconfig 0.6.5 documentation + libconfig.set_options_from_JSON — libconfig 0.6.7 documentation - - + + - @@ -21,7 +20,7 @@ - + @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -112,7 +111,7 @@

libconfig.set_options_from_JSON

- - +
Parameters:
    -
  • key (str) – First identifier of the option.
    • -
  • subkey (str) – Second identifier of the option.
    • +
  • key (str) – First identifier of the option.
    • +
  • subkey (str) – Second identifier of the option.
  • value – New value for the option (type varies).
Parameters:

filename (str) – File from which to load the options.

+
Parameters:

filename (str) – File from which to load the options.
Raise: @@ -148,7 +147,7 @@

libconfig.set_options_from_JSONSphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.set_options_from_YAML.html b/docs/generated/libconfig.set_options_from_YAML.html index 71a282f..c170150 100644 --- a/docs/generated/libconfig.set_options_from_YAML.html +++ b/docs/generated/libconfig.set_options_from_YAML.html @@ -4,16 +4,15 @@ - libconfig.set_options_from_YAML — libconfig 0.6.5 documentation + libconfig.set_options_from_YAML — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -112,7 +111,7 @@

libconfig.set_options_from_YAML

- - +
Parameters:

filename (str) – File from which to load the options.

+
Parameters:

filename (str) – File from which to load the options.
Raise: @@ -148,7 +147,7 @@

libconfig.set_options_from_YAMLSphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.set_options_from_dict.html b/docs/generated/libconfig.set_options_from_dict.html index 0eb1e70..cb54dad 100644 --- a/docs/generated/libconfig.set_options_from_dict.html +++ b/docs/generated/libconfig.set_options_from_dict.html @@ -4,16 +4,15 @@ - libconfig.set_options_from_dict — libconfig 0.6.5 documentation + libconfig.set_options_from_dict — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -112,7 +111,7 @@

libconfig.set_options_from_dict

- +
Parameters:data_dict (dict) – Dictionary with the options to load.
Parameters:data_dict (dict) – Dictionary with the options to load.
@@ -137,7 +136,7 @@

libconfig.set_options_from_dictSphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.set_options_from_file.html b/docs/generated/libconfig.set_options_from_file.html new file mode 100644 index 0000000..da05379 --- /dev/null +++ b/docs/generated/libconfig.set_options_from_file.html @@ -0,0 +1,170 @@ + + + + + + + libconfig.set_options_from_file — libconfig 0.6.7 documentation + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ +
+

libconfig.set_options_from_file

+
+
+libconfig.set_options_from_file(filename, format='yaml')
+

Load options from file.

+

This is a wrapper over set_options_from_JSON() and +set_options_from_YAML().

+ +++ + + + + + +
Parameters:
    +
  • filename (str) – File from which to load the options.
    • +
  • format (str) – File format (yaml or json).
    • +
+
Raises: +++ + + + +
ValueError:If an unknown format is requested.
+
+
+ +
+ + +
+ +
+
+ +
+
+

+ Back to top + +
+ + +

+

+ © Copyright 2018, Jaume Bonet.
+ Created using Sphinx 1.8.2.
+

+
+
+ + + + + + \ No newline at end of file diff --git a/docs/generated/libconfig.show_options.html b/docs/generated/libconfig.show_options.html index 7f5b7e9..cd4a07c 100644 --- a/docs/generated/libconfig.show_options.html +++ b/docs/generated/libconfig.show_options.html @@ -4,16 +4,15 @@ - libconfig.show_options — libconfig 0.6.5 documentation + libconfig.show_options — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,18 +105,18 @@

libconfig.show_options

-libconfig.show_options(*args, **kwargs)
-

Returns a copy the options DataFrame.

+libconfig.show_options(key='') +

Returns a copy the options DataFrame.

Called on jupyter notebook, it will print them in pretty -DataFrame format.

+DataFrame format.

- - +
Parameters:key (str) – First identifier of the option. If not provided, +
Parameters:key (str) – First identifier of the option. If not provided, all options are returned.
Returns:DataFrame
Returns:DataFrame
@@ -142,7 +141,7 @@

libconfig.show_options

© Copyright 2018, Jaume Bonet.
- Created using Sphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.write_options_to_JSON.html b/docs/generated/libconfig.write_options_to_JSON.html index 92da49d..9a67d19 100644 --- a/docs/generated/libconfig.write_options_to_JSON.html +++ b/docs/generated/libconfig.write_options_to_JSON.html @@ -4,16 +4,15 @@ - libconfig.write_options_to_JSON — libconfig 0.6.5 documentation + libconfig.write_options_to_JSON — libconfig 0.6.7 documentation - - + + - @@ -40,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -112,7 +111,7 @@

libconfig.write_options_to_JSON

Parameters:filename (str) – Target file to write the options.
Parameters:filename (str) – Target file to write the options.
@@ -137,7 +136,7 @@

libconfig.write_options_to_JSONSphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/generated/libconfig.write_options_to_YAML.html b/docs/generated/libconfig.write_options_to_YAML.html index 2a7f54d..62bf38c 100644 --- a/docs/generated/libconfig.write_options_to_YAML.html +++ b/docs/generated/libconfig.write_options_to_YAML.html @@ -4,22 +4,22 @@ - libconfig.write_options_to_YAML — libconfig 0.6.5 documentation + libconfig.write_options_to_YAML — libconfig 0.6.7 documentation - - + + - + @@ -39,7 +39,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -111,7 +111,7 @@

libconfig.write_options_to_YAML

Parameters:filename (str) – Target file to write the options.
Parameters:filename (str) – Target file to write the options.
@@ -136,7 +136,7 @@

libconfig.write_options_to_YAMLSphinx 1.7.2.
+ Created using Sphinx 1.8.2.

diff --git a/docs/genindex.html b/docs/genindex.html index cf6cefd..1aab37c 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -5,16 +5,15 @@ - Index — libconfig 0.6.5 documentation + Index — libconfig 0.6.7 documentation - - + + - @@ -39,7 +38,7 @@ libconfig - 0.6.5 + 0.6.7
@@ -106,6 +105,7 @@

Index

| D | G | L + | O | R | S | W @@ -130,6 +130,8 @@

D

G

@@ -149,6 +151,14 @@

L

+

O

+ + +
+

R

    @@ -211,7 +223,7 @@

    W

    © Copyright 2018, Jaume Bonet.
    - Created using Sphinx 1.7.2.
    + Created using Sphinx 1.8.2.

    diff --git a/docs/index.html b/docs/index.html index bb7bcd5..0616f7e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,16 +4,15 @@ - libconfig: global config variables for libraries — libconfig 0.6.5 documentation + libconfig: global config variables for libraries — libconfig 0.6.7 documentation - - + + - @@ -39,7 +38,7 @@ libconfig - 0.6.5 + 0.6.7
    @@ -148,20 +147,25 @@

    Basic Example
    In [4]: import pandas as pd
+
    In [2]: import pandas as pd
    ...: pd.set_option('display.width', 1000)
    ...: show_options()
    ...: 
-Out[6]: 
+Out[2]: 
   primary-key secondary-key  value      type default locked                               description values
-0  system      overwrite     False  bool      False   False  Allow overwriting already existing files  None 
-1  system      output        ./     path_out  ./      False  Default folder to output generated files  None 
-2  system      cpu           3      int       3       False  Available CPU for multiprocessing         None 
+0  opt         one           1      int       1       False  option 1                                  None 
+1  opt         two           2      int       2       False  option 2                                  None 
+2  system      overwrite     False  bool      False   False  Allow overwriting already existing files  None 
+3  system      output        ./     path_out  ./      False  Default folder to output generated files  None 
+4  system      cpu           3      int       3       False  Available CPU for multiprocessing         None 
 
    
 
    
 
    And exposing only to the rest of the library (and maybe to the user) the functions to modify those options
 in a controlled manner by taking out register_option() and reset_options() from the global view.
    
-
    A list of all the available functions can be found in the API.
    
+
    One can also make the target library able to be configured through a file defining the values of the registered
+options. Through get_local_config_file(), the library will search for a config file in the current working
+directory, the repo root or the user’s home, allowing for different levels of specific configuration.
    
+
    A list of all the available functions can be found in the API.
    @@ -184,7 +188,7 @@

    Basic ExampleSphinx 1.7.2.
    + Created using Sphinx 1.8.2.

    diff --git a/docs/objects.inv b/docs/objects.inv index aa250c5..b94ae85 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/search.html b/docs/search.html index ac9d95e..0cc946f 100644 --- a/docs/search.html +++ b/docs/search.html @@ -4,16 +4,15 @@ - Search — libconfig 0.6.5 documentation + Search — libconfig 0.6.7 documentation - - + + - @@ -46,7 +45,7 @@ libconfig - 0.6.5 + 0.6.7
    @@ -144,7 +143,7 @@

    Search

    © Copyright 2018, Jaume Bonet.
    - Created using Sphinx 1.7.2.
    + Created using Sphinx 1.8.2.

    diff --git a/docs/searchindex.js b/docs/searchindex.js index fb3df66..8ec5faf 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["api","generated/libconfig.check_option","generated/libconfig.document_options","generated/libconfig.get_option","generated/libconfig.get_option_default","generated/libconfig.get_option_description","generated/libconfig.lock_option","generated/libconfig.register_option","generated/libconfig.reset_option","generated/libconfig.reset_options","generated/libconfig.set_option","generated/libconfig.set_options_from_JSON","generated/libconfig.set_options_from_YAML","generated/libconfig.set_options_from_dict","generated/libconfig.show_options","generated/libconfig.write_options_to_JSON","generated/libconfig.write_options_to_YAML","index"],envversion:52,filenames:["api.rst","generated/libconfig.check_option.rst","generated/libconfig.document_options.rst","generated/libconfig.get_option.rst","generated/libconfig.get_option_default.rst","generated/libconfig.get_option_description.rst","generated/libconfig.lock_option.rst","generated/libconfig.register_option.rst","generated/libconfig.reset_option.rst","generated/libconfig.reset_options.rst","generated/libconfig.set_option.rst","generated/libconfig.set_options_from_JSON.rst","generated/libconfig.set_options_from_YAML.rst","generated/libconfig.set_options_from_dict.rst","generated/libconfig.show_options.rst","generated/libconfig.write_options_to_JSON.rst","generated/libconfig.write_options_to_YAML.rst","index.rst"],objects:{libconfig:{check_option:[1,0,1,""],document_options:[2,0,1,""],get_option:[3,0,1,""],get_option_default:[4,0,1,""],get_option_description:[5,0,1,""],lock_option:[6,0,1,""],register_option:[7,0,1,""],reset_option:[8,0,1,""],reset_options:[9,0,1,""],set_option:[10,0,1,""],set_options_from_JSON:[11,0,1,""],set_options_from_YAML:[12,0,1,""],set_options_from_dict:[13,0,1,""],show_options:[14,0,1,""],write_options_to_JSON:[15,0,1,""],write_options_to_YAML:[16,0,1,""]}},objnames:{"0":["py","function","Python function"]},objtypes:{"0":"py:function"},terms:{"default":[4,7,8,17],"final":17,"float":7,"function":[9,17],"import":17,"int":[7,17],"new":[7,10],"return":[1,2,3,4,5,14],"true":[7,9],"try":17,And:17,The:17,_type:7,accept:7,access:17,add:2,all:[9,14,17],allow:17,alreadi:[7,17],alter:7,amongst:1,ani:[1,3,4,5,6,8,10],api:17,arg:[1,3,4,5,6,7,8,10,14],avail:[1,7,10,17],avoid:17,back:9,belong:1,bool:[1,7,9,17],brief:7,bug:17,call:14,can:17,cannot:7,check:1,code:17,completelli:9,configur:17,control:[9,17],copi:14,core:17,cpp:17,cpu:17,cpu_count:17,creat:[7,17],current:3,data_dict:13,datafram:14,defin:[1,3,4,5,6,7,8,10],definit:7,del:17,describ:7,descript:[5,17],descriv:5,dict:13,dictionari:13,directli:17,displai:17,docstr:2,document:2,doe:[1,11,12],empti:9,end:17,equival:17,error:17,evalu:1,everi:17,except:17,exist:[11,12,17],expect:[1,10,17],explan:7,expos:17,fals:[9,17],file:[11,12,15,16,17],filenam:[11,12,15,16],first:[1,3,4,5,6,7,8,10,14],fit:1,folder:17,format:[11,12,14,15,16],found:17,from:[11,12,13,17],gener:[2,17],get:[3,4,5],github:17,given:1,has:[1,17],identifi:[1,3,4,5,6,7,8,10,14],ifdef:17,inspir:17,ioerror:[11,12],issu:17,its:9,json:15,jupyt:14,kei:[1,3,4,5,6,7,8,10,14,17],keyerror:[1,3,4,5,6,7,8,10],kwarg:[1,3,4,5,6,7,8,10,14],librari:2,like:17,limit:1,list:[7,17],load:[11,12,13,17],lock:[7,8,9,10,17],look:17,make:6,manag:17,manner:17,mayb:17,minim:17,modifi:17,most:17,multiprocess:17,name:17,none:17,notebook:14,obtion:[8,10],onli:17,option:[1,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],origin:9,our:17,out:17,output:17,overwrit:17,own:17,panda:17,paramet:[1,3,4,5,6,7,8,9,10,11,12,13,14,15,16],particular:5,pass:17,path_in:7,path_out:[7,17],pip:17,pleas:17,pretti:14,primari:17,print:14,problem:17,provid:[1,10,14],pypi:17,python:17,rais:[1,3,4,5,6,7,8,10,11,12,17],recal:17,regist:17,register_opt:17,remov:9,report:17,repositori:17,reset:8,reset_opt:17,rest:17,rosettasilenttoolbox:17,second:[1,3,4,5,6,7,8,10],secondari:17,see:17,set:[1,9,10,17],set_opt:17,setup:17,show_opt:17,singl:8,skip:9,start:17,str:[1,2,3,4,5,6,7,8,10,11,12,14,15,16],string:[5,7],subkei:[1,3,4,5,6,7,8,10],system:17,tabl:2,take:17,taken:17,target:[8,10,15,16],test:1,text:7,thei:17,them:[1,9,14,17],thi:[9,17],those:17,through:17,time:17,tracker:17,type:[1,3,4,7,10,17],unmut:6,use:17,user:17,valu:[1,3,4,7,8,9,10,17],valueerror:[1,8,10],vari:[1,3,4,7,10],vertion:17,view:17,visit:17,wai:17,when:[9,17],which:[11,12,17],width:17,work:17,write:[15,16],yaml:[11,12,16],you:17,your:17},titles:["API reference","libconfig.check_option","libconfig.document_options","libconfig.get_option","libconfig.get_option_default","libconfig.get_option_description","libconfig.lock_option","libconfig.register_option","libconfig.reset_option","libconfig.reset_options","libconfig.set_option","libconfig.set_options_from_JSON","libconfig.set_options_from_YAML","libconfig.set_options_from_dict","libconfig.show_options","libconfig.write_options_to_JSON","libconfig.write_options_to_YAML","libconfig: global config variables for libraries"],titleterms:{"function":0,api:0,basic:17,check_opt:1,config:17,document_opt:2,exampl:17,get_opt:3,get_option_default:4,get_option_descript:5,global:17,instal:17,libconfig:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],librari:17,lock_opt:6,refer:0,register_opt:7,reset_opt:[8,9],set_opt:10,set_options_from_dict:13,set_options_from_json:11,set_options_from_yaml:12,show_opt:14,variabl:17,write_options_to_json:15,write_options_to_yaml:16}}) \ No newline at end of file +Search.setIndex({docnames:["api","generated/libconfig.check_option","generated/libconfig.document_options","generated/libconfig.get_local_config_file","generated/libconfig.get_option","generated/libconfig.get_option_default","generated/libconfig.get_option_description","generated/libconfig.lock_option","generated/libconfig.on_option_value","generated/libconfig.register_option","generated/libconfig.reset_option","generated/libconfig.reset_options","generated/libconfig.set_option","generated/libconfig.set_options_from_JSON","generated/libconfig.set_options_from_YAML","generated/libconfig.set_options_from_dict","generated/libconfig.set_options_from_file","generated/libconfig.show_options","generated/libconfig.write_options_to_JSON","generated/libconfig.write_options_to_YAML","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,sphinx:55},filenames:["api.rst","generated/libconfig.check_option.rst","generated/libconfig.document_options.rst","generated/libconfig.get_local_config_file.rst","generated/libconfig.get_option.rst","generated/libconfig.get_option_default.rst","generated/libconfig.get_option_description.rst","generated/libconfig.lock_option.rst","generated/libconfig.on_option_value.rst","generated/libconfig.register_option.rst","generated/libconfig.reset_option.rst","generated/libconfig.reset_options.rst","generated/libconfig.set_option.rst","generated/libconfig.set_options_from_JSON.rst","generated/libconfig.set_options_from_YAML.rst","generated/libconfig.set_options_from_dict.rst","generated/libconfig.set_options_from_file.rst","generated/libconfig.show_options.rst","generated/libconfig.write_options_to_JSON.rst","generated/libconfig.write_options_to_YAML.rst","index.rst"],objects:{libconfig:{check_option:[1,0,1,""],document_options:[2,0,1,""],get_local_config_file:[3,0,1,""],get_option:[4,0,1,""],get_option_default:[5,0,1,""],get_option_description:[6,0,1,""],lock_option:[7,0,1,""],on_option_value:[8,1,1,""],register_option:[9,0,1,""],reset_option:[10,0,1,""],reset_options:[11,0,1,""],set_option:[12,0,1,""],set_options_from_JSON:[13,0,1,""],set_options_from_YAML:[14,0,1,""],set_options_from_dict:[15,0,1,""],set_options_from_file:[16,0,1,""],show_options:[17,0,1,""],write_options_to_JSON:[18,0,1,""],write_options_to_YAML:[19,0,1,""]}},objnames:{"0":["py","function","Python function"],"1":["py","class","Python class"]},objtypes:{"0":"py:function","1":"py:class"},terms:{"class":8,"default":[3,5,9,10,20],"final":20,"float":9,"function":[11,20],"import":[8,20],"int":[8,9,20],"new":[9,12],"return":[1,2,3,4,5,6,17],"true":[9,11],"try":20,And:20,One:20,The:20,There:3,__init__:[],_type:9,abl:20,accept:9,access:20,accur:[],add:2,all:[11,17,20],allow:[4,20],alreadi:[9,20],also:20,alter:9,amongst:1,ani:[1,4,5,6,7,10,12],api:20,arg:8,avail:[1,9,12,20],avoid:20,back:11,belong:1,bool:[1,4,9,11,20],brief:9,bug:20,call:17,can:20,cannot:[8,9],cast:8,cfg:8,chang:8,check:1,code:20,completelli:11,config:3,configur:[3,8,20],control:[11,20],copi:17,core:20,cpp:20,cpu:20,cpu_count:20,creat:[9,20],current:[3,4,20],data_dict:15,datafram:17,defin:[1,4,5,6,7,9,10,12,20],definit:9,del:20,describ:9,descript:[6,20],descriv:6,dict:15,dictionari:15,differ:20,directli:20,directori:[3,20],displai:20,docstr:2,document:2,doe:[1,13,14],empti:11,end:20,equival:20,error:20,evalu:1,everi:20,except:20,exist:[13,14,20],expect:[1,12,20],explan:9,expos:20,fals:[4,9,11,20],file:[3,13,14,16,18,19,20],filenam:[3,13,14,16,18,19],find:3,first:[1,4,5,6,7,9,10,12,17],fit:1,fix:3,folder:20,format:[13,14,16,17,18,19],found:[3,20],from:[3,13,14,15,16,20],gener:[2,20],get:[4,5,6],get_local_config_fil:20,get_opt:8,git:3,github:20,given:1,has:[1,20],help:[],high:3,highest:3,home:[3,20],how:3,identifi:[1,4,5,6,7,9,10,12,17],ifdef:20,in_path:4,in_path_non:4,initi:[],inspir:20,ioerror:[13,14],issu:20,its:11,json:[16,18],jupyt:17,kei:[1,4,5,6,7,9,10,12,17,20],keyerror:[1,4,5,6,7,9,10,12],level:20,librari:2,like:20,limit:1,list:[9,20],load:[13,14,15,16,20],local:3,lock:[9,10,11,12,20],logic:3,look:20,lowest:3,make:[7,20],manag:20,manner:20,mayb:20,method:[],minim:20,modifi:20,most:20,multipl:8,multiprocess:20,name:[3,20],need:3,next:3,none:[3,4,9,20],notebook:17,number:8,obtion:[10,12],one:[8,20],onli:20,opt:[8,20],option:[1,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],origin:11,our:20,out:20,output:20,over:16,overwrit:20,own:20,panda:20,paramet:[1,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],particular:6,pass:20,path_in:9,path_out:[9,20],perform:3,pip:20,pleas:20,pre:3,pretti:17,primari:20,print:[8,17],prioriti:3,problem:20,project:3,provid:[1,12,17],pypi:20,python:20,rais:[1,4,5,6,7,8,9,10,12,13,14,16,20],raw:3,recal:20,regist:20,register_opt:[8,20],remov:11,repo:20,report:20,repositori:[3,20],request:[4,16],reset:10,reset_opt:20,rest:20,retriev:4,root:[3,20],rosettasilenttoolbox:20,search:[3,20],second:[1,4,5,6,7,9,10,12],secondari:20,see:20,self:[],set:[1,11,12,20],set_opt:20,set_options_from_json:16,set_options_from_yaml:16,setup:[3,20],show_opt:20,signatur:[],singl:10,skip:11,specif:20,start:20,str:[1,2,3,4,5,6,7,9,10,12,13,14,16,17,18,19],string:[6,9],subkei:[1,4,5,6,7,9,10,12],system:20,tabl:2,take:20,taken:20,target:[10,12,18,19,20],temporarili:8,test:1,text:9,thei:20,them:[1,11,17,20],thi:[11,16,20],those:20,through:20,time:20,tracker:20,two:[8,20],type:[1,4,5,9,12,20],union:3,unknown:16,unmut:7,use:20,user:[3,20],valu:[1,3,4,5,8,9,10,11,12,20],valueerror:[1,4,8,10,12,16],vari:[1,4,5,9,12],vertion:20,view:20,visit:20,wai:20,when:[11,20],which:[13,14,16,20],width:20,work:[3,20],wrapper:16,write:[18,19],yaml:[13,14,16,19],you:20,your:20},titles:["API reference","libconfig.check_option","libconfig.document_options","libconfig.get_local_config_file","libconfig.get_option","libconfig.get_option_default","libconfig.get_option_description","libconfig.lock_option","libconfig.on_option_value","libconfig.register_option","libconfig.reset_option","libconfig.reset_options","libconfig.set_option","libconfig.set_options_from_JSON","libconfig.set_options_from_YAML","libconfig.set_options_from_dict","libconfig.set_options_from_file","libconfig.show_options","libconfig.write_options_to_JSON","libconfig.write_options_to_YAML","libconfig: global config variables for libraries"],titleterms:{"function":0,api:0,basic:20,check_opt:1,config:20,document_opt:2,exampl:20,get_local_config_fil:3,get_opt:4,get_option_default:5,get_option_descript:6,global:20,instal:20,libconfig:[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],librari:20,lock_opt:7,on_option_valu:8,refer:0,register_opt:9,reset_opt:[10,11],set_opt:12,set_options_from_dict:15,set_options_from_fil:16,set_options_from_json:13,set_options_from_yaml:14,show_opt:17,variabl:20,write_options_to_json:18,write_options_to_yaml:19}}) \ No newline at end of file diff --git a/libconfig/config.py b/libconfig/config.py index 1fd25e9..9769871 100644 --- a/libconfig/config.py +++ b/libconfig/config.py @@ -472,7 +472,7 @@ def get_local_config_file(filename): 1. **Local:** Configuration file found in the current working directory. 2. **Project:** Configuration file found in the root of the current - working ``git`` repository. + working ``git`` repository. 3. **User:** Configuration file found in the user's ``$HOME``. :param str filename: Raw name of the configuration file. diff --git a/sphinx-docs/source/generated/libconfig.get_local_config_file.rst b/sphinx-docs/source/generated/libconfig.get_local_config_file.rst new file mode 100644 index 0000000..424c090 --- /dev/null +++ b/sphinx-docs/source/generated/libconfig.get_local_config_file.rst @@ -0,0 +1,6 @@ +libconfig.get\_local\_config\_file +================================== + +.. currentmodule:: libconfig + +.. autofunction:: get_local_config_file \ No newline at end of file diff --git a/sphinx-docs/source/generated/libconfig.on_option_value.rst b/sphinx-docs/source/generated/libconfig.on_option_value.rst new file mode 100644 index 0000000..7b78cf8 --- /dev/null +++ b/sphinx-docs/source/generated/libconfig.on_option_value.rst @@ -0,0 +1,6 @@ +libconfig.on\_option\_value +=========================== + +.. currentmodule:: libconfig + +.. autoclass:: on_option_value diff --git a/sphinx-docs/source/generated/libconfig.set_options_from_file.rst b/sphinx-docs/source/generated/libconfig.set_options_from_file.rst new file mode 100644 index 0000000..2376afe --- /dev/null +++ b/sphinx-docs/source/generated/libconfig.set_options_from_file.rst @@ -0,0 +1,6 @@ +libconfig.set\_options\_from\_file +================================== + +.. currentmodule:: libconfig + +.. autofunction:: set_options_from_file \ No newline at end of file diff --git a/sphinx-docs/source/index.rst b/sphinx-docs/source/index.rst index 60dc466..d040c27 100644 --- a/sphinx-docs/source/index.rst +++ b/sphinx-docs/source/index.rst @@ -63,6 +63,10 @@ This ends up loading a starting set of options: And exposing only to the rest of the library (and maybe to the user) the functions to modify those options in a controlled manner by taking out :func:`.register_option` and :func:`.reset_options` from the global view. +One can also make the target library able to be configured through a file defining the values of the registered +options. Through :func:`.get_local_config_file`, the library will search for a config file in the current working +directory, the repo root or the user's home, allowing for different levels of specific configuration. + A list of all the available functions can be found in the :ref:`API `. .. toctree::