Update to 0.8.0
This commit is contained in:
parent
eb05713453
commit
7f1a6e7773
22 changed files with 954 additions and 701 deletions
|
@ -4,7 +4,7 @@
|
||||||
*
|
*
|
||||||
* Sphinx stylesheet -- basic theme.
|
* Sphinx stylesheet -- basic theme.
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -81,6 +81,10 @@ div.sphinxsidebar input {
|
||||||
font-size: 1em;
|
font-size: 1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar #searchbox form.search {
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
div.sphinxsidebar #searchbox input[type="text"] {
|
div.sphinxsidebar #searchbox input[type="text"] {
|
||||||
float: left;
|
float: left;
|
||||||
width: 80%;
|
width: 80%;
|
||||||
|
@ -427,6 +431,13 @@ table.field-list td, table.field-list th {
|
||||||
hyphens: manual;
|
hyphens: manual;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* -- hlist styles ---------------------------------------------------------- */
|
||||||
|
|
||||||
|
table.hlist td {
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
/* -- other body styles ----------------------------------------------------- */
|
/* -- other body styles ----------------------------------------------------- */
|
||||||
|
|
||||||
ol.arabic {
|
ol.arabic {
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
*
|
*
|
||||||
* Sphinx JavaScript utilities for all documentation.
|
* Sphinx JavaScript utilities for all documentation.
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -70,7 +70,9 @@ jQuery.fn.highlightText = function(text, className) {
|
||||||
if (node.nodeType === 3) {
|
if (node.nodeType === 3) {
|
||||||
var val = node.nodeValue;
|
var val = node.nodeValue;
|
||||||
var pos = val.toLowerCase().indexOf(text);
|
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 span;
|
||||||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||||
if (isInSVG) {
|
if (isInSVG) {
|
||||||
|
@ -148,7 +150,9 @@ var Documentation = {
|
||||||
this.fixFirefoxAnchorBug();
|
this.fixFirefoxAnchorBug();
|
||||||
this.highlightSearchWords();
|
this.highlightSearchWords();
|
||||||
this.initIndexTable();
|
this.initIndexTable();
|
||||||
|
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
|
||||||
|
this.initOnKeyListeners();
|
||||||
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
10
_static/documentation_options.js
Normal file
10
_static/documentation_options.js
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
var DOCUMENTATION_OPTIONS = {
|
||||||
|
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||||
|
VERSION: '0.8.0',
|
||||||
|
LANGUAGE: 'None',
|
||||||
|
COLLAPSE_INDEX: false,
|
||||||
|
FILE_SUFFIX: '.html',
|
||||||
|
HAS_SOURCE: true,
|
||||||
|
SOURCELINK_SUFFIX: '.txt',
|
||||||
|
NAVIGATION_WITH_KEYS: false,
|
||||||
|
};
|
|
@ -16,7 +16,7 @@
|
||||||
* Braden Ewing <brewin@gmail.com>
|
* Braden Ewing <brewin@gmail.com>
|
||||||
* Humdinger <humdingerb@gmail.com>
|
* Humdinger <humdingerb@gmail.com>
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
771
_static/jquery-3.1.0.js → _static/jquery-3.2.1.js
vendored
771
_static/jquery-3.1.0.js → _static/jquery-3.2.1.js
vendored
File diff suppressed because it is too large
Load diff
297
_static/language_data.js
Normal file
297
_static/language_data.js
Normal file
|
@ -0,0 +1,297 @@
|
||||||
|
/*
|
||||||
|
* language_data.js
|
||||||
|
* ~~~~~~~~~~~~~~~~
|
||||||
|
*
|
||||||
|
* This script contains the language-specific data used by searchtools.js,
|
||||||
|
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||||
|
*
|
||||||
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
|
* :license: BSD, see LICENSE for details.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
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"];
|
||||||
|
|
||||||
|
|
||||||
|
/* 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;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,331 +1,52 @@
|
||||||
/*
|
/*
|
||||||
* searchtools.js_t
|
* searchtools.js
|
||||||
* ~~~~~~~~~~~~~~~~
|
* ~~~~~~~~~~~~~~~~
|
||||||
*
|
*
|
||||||
* Sphinx JavaScript utilities for the full-text search.
|
* Sphinx JavaScript utilities for the full-text search.
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
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];
|
||||||
|
},
|
||||||
|
*/
|
||||||
|
|
||||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
// query matches the full name of an object
|
||||||
/**
|
objNameMatch: 11,
|
||||||
* Porter Stemmer
|
// or matches in the last dotted part of the object name
|
||||||
*/
|
objPartialMatch: 6,
|
||||||
var Stemmer = function() {
|
// 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,
|
||||||
|
|
||||||
var step2list = {
|
// query found in title
|
||||||
ational: 'ate',
|
title: 15,
|
||||||
tional: 'tion',
|
// query found in terms
|
||||||
enci: 'ence',
|
term: 5
|
||||||
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 = {
|
if (!splitQuery) {
|
||||||
icate: 'ic',
|
function splitQuery(query) {
|
||||||
ative: '',
|
return query.split(/\s+/);
|
||||||
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;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Search Module
|
* Search Module
|
||||||
*/
|
*/
|
||||||
|
@ -417,7 +138,6 @@ var Search = {
|
||||||
*/
|
*/
|
||||||
query : function(query) {
|
query : function(query) {
|
||||||
var i;
|
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"];
|
|
||||||
|
|
||||||
// stem the searchterms and add them to the correct list
|
// stem the searchterms and add them to the correct list
|
||||||
var stemmer = new Stemmer();
|
var stemmer = new Stemmer();
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
*
|
*
|
||||||
* sphinx.websupport utilities for all documentation.
|
* sphinx.websupport utilities for all documentation.
|
||||||
*
|
*
|
||||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||||
* :license: BSD, see LICENSE for details.
|
* :license: BSD, see LICENSE for details.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -6,20 +6,21 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>feedgen.entry — python-feedgen 0.7.0 documentation</title>
|
<title>feedgen.entry — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="feedgen.util" href="api.util.html" />
|
<link rel="next" title="feedgen.util" href="api.util.html" />
|
||||||
<link rel="prev" title="feedgen.feed" href="api.feed.html" />
|
<link rel="prev" title="feedgen.feed" href="api.feed.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>feedgen.entry</span></h2>
|
<h2 class="heading"><span>feedgen.entry</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -135,8 +136,8 @@ is used. The scheme is used for the domain attribute in RSS.</p>
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="feedgen.entry.FeedEntry.comments">
|
<dt id="feedgen.entry.FeedEntry.comments">
|
||||||
<code class="descname">comments</code><span class="sig-paren">(</span><em>comments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.comments" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">comments</code><span class="sig-paren">(</span><em>comments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.comments" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Get or set the the value of comments which is the url of the
|
<dd><p>Get or set the value of comments which is the URL of the comments
|
||||||
comments page for the item. This is a RSS only value.</p>
|
page for the item. This is a RSS only value.</p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<table class="docutils field-list" frame="void" rules="none">
|
||||||
<col class="field-name" />
|
<col class="field-name" />
|
||||||
<col class="field-body" />
|
<col class="field-body" />
|
||||||
|
@ -152,7 +153,7 @@ comments page for the item. This is a RSS only value.</p>
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="feedgen.entry.FeedEntry.content">
|
<dt id="feedgen.entry.FeedEntry.content">
|
||||||
<code class="descname">content</code><span class="sig-paren">(</span><em>content=None</em>, <em>src=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.content" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">content</code><span class="sig-paren">(</span><em>content=None</em>, <em>src=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.content" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Get or set the cntent of the entry which contains or links to the
|
<dd><p>Get or set the content of the entry which contains or links to the
|
||||||
complete content of the entry. Content must be provided for ATOM
|
complete content of the entry. Content must be provided for ATOM
|
||||||
entries if there is no alternate link, and should be provided if there
|
entries if there is no alternate link, and should be provided if there
|
||||||
is no summary. If the content is set (not linked) it will also set
|
is no summary. If the content is set (not linked) it will also set
|
||||||
|
@ -395,7 +396,7 @@ method.</p>
|
||||||
<dd><p>Get or set the pubDate of the entry which indicates when the entry
|
<dd><p>Get or set the pubDate of the entry which indicates when the entry
|
||||||
was published. This method is just another name for the published(…)
|
was published. This method is just another name for the published(…)
|
||||||
method.</p>
|
method.</p>
|
||||||
<p>pubdate(…) is deprected and may be removed in feedgen ≥ 0.8. Use
|
<p>pubdate(…) is deprecated and may be removed in feedgen ≥ 0.8. Use
|
||||||
pubDate(…) instead.</p>
|
pubDate(…) instead.</p>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
|
@ -463,6 +464,30 @@ value will also set rss:copyright.</p>
|
||||||
<dd><p>Create a RSS item and return it.</p>
|
<dd><p>Create a RSS item and return it.</p>
|
||||||
</dd></dl>
|
</dd></dl>
|
||||||
|
|
||||||
|
<dl class="method">
|
||||||
|
<dt id="feedgen.entry.FeedEntry.source">
|
||||||
|
<code class="descname">source</code><span class="sig-paren">(</span><em>url=None</em>, <em>title=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.source" title="Permalink to this definition">¶</a></dt>
|
||||||
|
<dd><p>Get or set the source for the current feed entry.</p>
|
||||||
|
<p>Note that ATOM feeds support a lot more sub elements than title and URL
|
||||||
|
(which is what RSS supports) but these are currently not supported.
|
||||||
|
Patches are welcome.</p>
|
||||||
|
<table class="docutils field-list" frame="void" rules="none">
|
||||||
|
<col class="field-name" />
|
||||||
|
<col class="field-body" />
|
||||||
|
<tbody valign="top">
|
||||||
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||||
|
<li><strong>url</strong> – Link to the source.</li>
|
||||||
|
<li><strong>title</strong> – Title of the linked resource</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Source element as dictionaries.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</dd></dl>
|
||||||
|
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="feedgen.entry.FeedEntry.summary">
|
<dt id="feedgen.entry.FeedEntry.summary">
|
||||||
<code class="descname">summary</code><span class="sig-paren">(</span><em>summary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.summary" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">summary</code><span class="sig-paren">(</span><em>summary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.summary" title="Permalink to this definition">¶</a></dt>
|
||||||
|
@ -561,7 +586,7 @@ include timezone information.</p>
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
|
@ -6,20 +6,21 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>feedgen.feed — python-feedgen 0.7.0 documentation</title>
|
<title>feedgen.feed — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="feedgen.entry" href="api.entry.html" />
|
<link rel="next" title="feedgen.entry" href="api.entry.html" />
|
||||||
<link rel="prev" title="API Documentation" href="api.html" />
|
<link rel="prev" title="API Documentation" href="api.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>feedgen.feed</span></h2>
|
<h2 class="heading"><span>feedgen.feed</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -958,7 +959,7 @@ feed. This is an RSS only value.</p>
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
13
api.html
13
api.html
|
@ -6,20 +6,21 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>API Documentation — python-feedgen 0.7.0 documentation</title>
|
<title>API Documentation — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="feedgen.feed" href="api.feed.html" />
|
<link rel="next" title="feedgen.feed" href="api.feed.html" />
|
||||||
<link rel="prev" title="Feedgenerator" href="index.html" />
|
<link rel="prev" title="Feedgenerator" href="index.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>API Documentation</span></h2>
|
<h2 class="heading"><span>API Documentation</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -55,7 +56,7 @@ produce Podcasts.</p>
|
||||||
</table>
|
</table>
|
||||||
<div class="section" id="create-a-feed">
|
<div class="section" id="create-a-feed">
|
||||||
<h3>Create a Feed<a class="headerlink" href="#create-a-feed" title="Permalink to this headline">¶</a></h3>
|
<h3>Create a Feed<a class="headerlink" href="#create-a-feed" title="Permalink to this headline">¶</a></h3>
|
||||||
<p>To create a feed simply instanciate the FeedGenerator class and insert some
|
<p>To create a feed simply instantiate the FeedGenerator class and insert some
|
||||||
data:</p>
|
data:</p>
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="k">import</span> <span class="n">FeedGenerator</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="k">import</span> <span class="n">FeedGenerator</span>
|
||||||
<span class="gp">>>> </span><span class="n">fg</span> <span class="o">=</span> <span class="n">FeedGenerator</span><span class="p">()</span>
|
<span class="gp">>>> </span><span class="n">fg</span> <span class="o">=</span> <span class="n">FeedGenerator</span><span class="p">()</span>
|
||||||
|
@ -130,7 +131,7 @@ located either in the same file as SomextExtension or in
|
||||||
should only be used for either ATOM or RSS feeds. The default value for
|
should only be used for either ATOM or RSS feeds. The default value for
|
||||||
both parameters is true which means that the extension would be used for
|
both parameters is true which means that the extension would be used for
|
||||||
both kinds of feeds.</p>
|
both kinds of feeds.</p>
|
||||||
<p><strong>Example: Produceing a Podcast</strong></p>
|
<p><strong>Example: Producing a Podcast</strong></p>
|
||||||
<p>One extension already provided is the podcast extension. A podcast is an
|
<p>One extension already provided is the podcast extension. A podcast is an
|
||||||
RSS feed with some additional elements for ITunes.</p>
|
RSS feed with some additional elements for ITunes.</p>
|
||||||
<p>To produce a podcast simply load the <cite>podcast</cite> extension:</p>
|
<p>To produce a podcast simply load the <cite>podcast</cite> extension:</p>
|
||||||
|
@ -193,7 +194,7 @@ This can be done by calling the generating method with the keyword argument
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
|
@ -6,20 +6,21 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>feedgen.util — python-feedgen 0.7.0 documentation</title>
|
<title>feedgen.util — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="feedgen.ext.base" href="ext/api.ext.base.html" />
|
<link rel="next" title="feedgen.ext.base" href="ext/api.ext.base.html" />
|
||||||
<link rel="prev" title="feedgen.entry" href="api.entry.html" />
|
<link rel="prev" title="feedgen.entry" href="api.entry.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>feedgen.util</span></h2>
|
<h2 class="heading"><span>feedgen.util</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -102,7 +103,7 @@ values.</li>
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
|
@ -6,20 +6,21 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>feedgen.ext.base — python-feedgen 0.7.0 documentation</title>
|
<title>feedgen.ext.base — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="../_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="../genindex.html" />
|
<link rel="index" title="Index" href="../genindex.html" />
|
||||||
<link rel="search" title="Search" href="../search.html" />
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
<link rel="next" title="feedgen.ext.dc" href="api.ext.dc.html" />
|
<link rel="next" title="feedgen.ext.dc" href="api.ext.dc.html" />
|
||||||
<link rel="prev" title="feedgen.util" href="../api.util.html" />
|
<link rel="prev" title="feedgen.util" href="../api.util.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>feedgen.ext.base</span></h2>
|
<h2 class="heading"><span>feedgen.ext.base</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -121,7 +122,7 @@ fields.</p>
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
|
@ -6,20 +6,21 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>feedgen.ext.dc — python-feedgen 0.7.0 documentation</title>
|
<title>feedgen.ext.dc — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="../_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="../genindex.html" />
|
<link rel="index" title="Index" href="../genindex.html" />
|
||||||
<link rel="search" title="Search" href="../search.html" />
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
<link rel="next" title="feedgen.ext.podcast" href="api.ext.podcast.html" />
|
<link rel="next" title="feedgen.ext.podcast" href="api.ext.podcast.html" />
|
||||||
<link rel="prev" title="feedgen.ext.base" href="api.ext.base.html" />
|
<link rel="prev" title="feedgen.ext.base" href="api.ext.base.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>feedgen.ext.dc</span></h2>
|
<h2 class="heading"><span>feedgen.ext.dc</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -284,7 +285,7 @@ making the resource available.</p>
|
||||||
<dl class="method">
|
<dl class="method">
|
||||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_relation">
|
<dt id="feedgen.ext.dc.DcBaseExtension.dc_relation">
|
||||||
<code class="descname">dc_relation</code><span class="sig-paren">(</span><em>relation=None</em>, <em>replace=False</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_relation" title="Permalink to this definition">¶</a></dt>
|
<code class="descname">dc_relation</code><span class="sig-paren">(</span><em>relation=None</em>, <em>replace=False</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_relation" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>Get or set the dc:relation which describes a related ressource.</p>
|
<dd><p>Get or set the dc:relation which describes a related resource.</p>
|
||||||
<p>For more information see:
|
<p>For more information see:
|
||||||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-relation">http://dublincore.org/documents/dcmi-terms/#elements-relation</a></p>
|
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-relation">http://dublincore.org/documents/dcmi-terms/#elements-relation</a></p>
|
||||||
<table class="docutils field-list" frame="void" rules="none">
|
<table class="docutils field-list" frame="void" rules="none">
|
||||||
|
@ -528,7 +529,7 @@ resource.</p>
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
|
@ -6,20 +6,21 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>feedgen.ext.podcast — python-feedgen 0.7.0 documentation</title>
|
<title>feedgen.ext.podcast — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="../_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="../genindex.html" />
|
<link rel="index" title="Index" href="../genindex.html" />
|
||||||
<link rel="search" title="Search" href="../search.html" />
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
<link rel="next" title="feedgen.ext.podcast_entry" href="api.ext.podcast_entry.html" />
|
<link rel="next" title="feedgen.ext.podcast_entry" href="api.ext.podcast_entry.html" />
|
||||||
<link rel="prev" title="feedgen.ext.dc" href="api.ext.dc.html" />
|
<link rel="prev" title="feedgen.ext.dc" href="api.ext.dc.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>feedgen.ext.podcast</span></h2>
|
<h2 class="heading"><span>feedgen.ext.podcast</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -340,7 +341,7 @@ tag are used.</p>
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
|
@ -6,20 +6,21 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>feedgen.ext.podcast_entry — python-feedgen 0.7.0 documentation</title>
|
<title>feedgen.ext.podcast_entry — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="../_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="../genindex.html" />
|
<link rel="index" title="Index" href="../genindex.html" />
|
||||||
<link rel="search" title="Search" href="../search.html" />
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
<link rel="next" title="feedgen.ext.torrent" href="api.ext.torrent.html" />
|
<link rel="next" title="feedgen.ext.torrent" href="api.ext.torrent.html" />
|
||||||
<link rel="prev" title="feedgen.ext.podcast" href="api.ext.podcast.html" />
|
<link rel="prev" title="feedgen.ext.podcast" href="api.ext.podcast.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>feedgen.ext.podcast_entry</span></h2>
|
<h2 class="heading"><span>feedgen.ext.podcast_entry</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -291,7 +292,7 @@ characters. If <itunes:summary> is not included, the contents of the
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
|
@ -6,19 +6,20 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>feedgen.ext.torrent — python-feedgen 0.7.0 documentation</title>
|
<title>feedgen.ext.torrent — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="../_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="../genindex.html" />
|
<link rel="index" title="Index" href="../genindex.html" />
|
||||||
<link rel="search" title="Search" href="../search.html" />
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
<link rel="prev" title="feedgen.ext.podcast_entry" href="api.ext.podcast_entry.html" />
|
<link rel="prev" title="feedgen.ext.podcast_entry" href="api.ext.podcast_entry.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>feedgen.ext.torrent</span></h2>
|
<h2 class="heading"><span>feedgen.ext.torrent</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -192,7 +193,7 @@
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
|
@ -7,18 +7,19 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>Index — python-feedgen 0.7.0 documentation</title>
|
<title>Index — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="#" />
|
<link rel="index" title="Index" href="#" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>Index</span></h2>
|
<h2 class="heading"><span>Index</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -430,10 +431,12 @@
|
||||||
<li><a href="ext/api.ext.torrent.html#feedgen.ext.torrent.TorrentEntryExtension.seeds">seeds() (feedgen.ext.torrent.TorrentEntryExtension method)</a>
|
<li><a href="ext/api.ext.torrent.html#feedgen.ext.torrent.TorrentEntryExtension.seeds">seeds() (feedgen.ext.torrent.TorrentEntryExtension method)</a>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="api.feed.html#feedgen.feed.FeedGenerator.skipDays">skipDays() (feedgen.feed.FeedGenerator method)</a>
|
<li><a href="api.feed.html#feedgen.feed.FeedGenerator.skipDays">skipDays() (feedgen.feed.FeedGenerator method)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="api.feed.html#feedgen.feed.FeedGenerator.skipHours">skipHours() (feedgen.feed.FeedGenerator method)</a>
|
||||||
</li>
|
</li>
|
||||||
</ul></td>
|
</ul></td>
|
||||||
<td style="width: 33%; vertical-align: top;"><ul>
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
<li><a href="api.feed.html#feedgen.feed.FeedGenerator.skipHours">skipHours() (feedgen.feed.FeedGenerator method)</a>
|
<li><a href="api.entry.html#feedgen.entry.FeedEntry.source">source() (feedgen.entry.FeedEntry method)</a>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="api.feed.html#feedgen.feed.FeedGenerator.subtitle">subtitle() (feedgen.feed.FeedGenerator method)</a>
|
<li><a href="api.feed.html#feedgen.feed.FeedGenerator.subtitle">subtitle() (feedgen.feed.FeedGenerator method)</a>
|
||||||
</li>
|
</li>
|
||||||
|
@ -509,7 +512,7 @@
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
47
index.html
47
index.html
|
@ -6,19 +6,20 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>Feedgenerator — python-feedgen 0.7.0 documentation</title>
|
<title>Feedgenerator — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
<link rel="next" title="API Documentation" href="api.html" />
|
<link rel="next" title="API Documentation" href="api.html" />
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="#">
|
<div class="header" role="banner"><h1 class="heading"><a href="#">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>Feedgenerator</span></h2>
|
<h2 class="heading"><span>Feedgenerator</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -53,29 +54,24 @@
|
||||||
<h1><a class="toc-backref" href="#id1">Feedgenerator</a><a class="headerlink" href="#feedgenerator" title="Permalink to this headline">¶</a></h1>
|
<h1><a class="toc-backref" href="#id1">Feedgenerator</a><a class="headerlink" href="#feedgenerator" title="Permalink to this headline">¶</a></h1>
|
||||||
<a class="reference external image-reference" href="https://travis-ci.org/lkiesow/python-feedgen"><img alt="Build Status" src="https://travis-ci.org/lkiesow/python-feedgen.svg?branch=master" /></a>
|
<a class="reference external image-reference" href="https://travis-ci.org/lkiesow/python-feedgen"><img alt="Build Status" src="https://travis-ci.org/lkiesow/python-feedgen.svg?branch=master" /></a>
|
||||||
<a class="reference external image-reference" href="https://coveralls.io/github/lkiesow/python-feedgen?branch=master"><img alt="Test Coverage Status" src="https://coveralls.io/repos/github/lkiesow/python-feedgen/badge.svg?branch=master" /></a>
|
<a class="reference external image-reference" href="https://coveralls.io/github/lkiesow/python-feedgen?branch=master"><img alt="Test Coverage Status" src="https://coveralls.io/repos/github/lkiesow/python-feedgen/badge.svg?branch=master" /></a>
|
||||||
<p>This module can be used to generate web feeds in both ATOM and RSS format. It
|
<p>This module can be used to generate web feeds in both ATOM and RSS format. It
|
||||||
has support for extensions. Included is for example an extension to produce Podcasts.</p>
|
has support for extensions. Included is for example an extension to produce
|
||||||
|
Podcasts.</p>
|
||||||
<p>It is licensed under the terms of both, the FreeBSD license and the LGPLv3+.
|
<p>It is licensed under the terms of both, the FreeBSD license and the LGPLv3+.
|
||||||
Choose the one which is more convenient for you. For more details have a look
|
Choose the one which is more convenient for you. For more details have a look
|
||||||
at license.bsd and license.lgpl.</p>
|
at license.bsd and license.lgpl.</p>
|
||||||
<p>More details about the project:</p>
|
<p>More details about the project:</p>
|
||||||
<ul class="simple">
|
<ul class="simple">
|
||||||
<li>Repository: <a class="reference external" href="https://github.com/lkiesow/python-feedgen">https://github.com/lkiesow/python-feedgen</a></li>
|
<li>Repository: <a class="reference external" href="https://github.com/lkiesow/python-feedgen">https://github.com/lkiesow/python-feedgen</a></li>
|
||||||
<li>Documentation: <a class="reference external" href="http://lkiesow.github.io/python-feedgen/">http://lkiesow.github.io/python-feedgen/</a></li>
|
<li>Documentation: <a class="reference external" href="https://lkiesow.github.io/python-feedgen/">https://lkiesow.github.io/python-feedgen/</a></li>
|
||||||
<li>Python Package Index: <a class="reference external" href="https://pypi.python.org/pypi/feedgen/">https://pypi.python.org/pypi/feedgen/</a></li>
|
<li>Python Package Index: <a class="reference external" href="https://pypi.python.org/pypi/feedgen/">https://pypi.python.org/pypi/feedgen/</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
<div class="section" id="installation">
|
<div class="section" id="installation">
|
||||||
<h2><a class="toc-backref" href="#id2">Installation</a><a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
|
<h2><a class="toc-backref" href="#id2">Installation</a><a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
|
||||||
<p><strong>Prebuild packages</strong></p>
|
<p><strong>Prebuild packages</strong></p>
|
||||||
<p>If you are running Fedora Linux, RedHat Enterprise Linux, CentOS or Scientific
|
<p>If your distribution includes this project as package, like Fedora Linux does,
|
||||||
Linux you can use the RPM Copr repostiory:</p>
|
you can simply use your package manager to install the package. For example:</p>
|
||||||
<p><a class="reference external" href="http://copr.fedoraproject.org/coprs/lkiesow/python-feedgen/">http://copr.fedoraproject.org/coprs/lkiesow/python-feedgen/</a></p>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ dnf install python3-feedgen
|
||||||
<p>Simply enable the repository and run:</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ yum install python-feedgen
|
|
||||||
</pre></div>
|
|
||||||
</div>
|
|
||||||
<p>or for the Python 3 package:</p>
|
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ yum install python3-feedgen
|
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p><strong>Using pip</strong></p>
|
<p><strong>Using pip</strong></p>
|
||||||
|
@ -86,7 +82,7 @@ Linux you can use the RPM Copr repostiory:</p>
|
||||||
</div>
|
</div>
|
||||||
<div class="section" id="create-a-feed">
|
<div class="section" id="create-a-feed">
|
||||||
<h2><a class="toc-backref" href="#id3">Create a Feed</a><a class="headerlink" href="#create-a-feed" title="Permalink to this headline">¶</a></h2>
|
<h2><a class="toc-backref" href="#id3">Create a Feed</a><a class="headerlink" href="#create-a-feed" title="Permalink to this headline">¶</a></h2>
|
||||||
<p>To create a feed simply instanciate the FeedGenerator class and insert some
|
<p>To create a feed simply instantiate the FeedGenerator class and insert some
|
||||||
data:</p>
|
data:</p>
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="k">import</span> <span class="n">FeedGenerator</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="k">import</span> <span class="n">FeedGenerator</span>
|
||||||
<span class="gp">>>> </span><span class="n">fg</span> <span class="o">=</span> <span class="n">FeedGenerator</span><span class="p">()</span>
|
<span class="gp">>>> </span><span class="n">fg</span> <span class="o">=</span> <span class="n">FeedGenerator</span><span class="p">()</span>
|
||||||
|
@ -179,17 +175,14 @@ feed with some additional elements for ITunes.</p>
|
||||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_file</span><span class="p">(</span><span class="s1">'podcast.xml'</span><span class="p">)</span>
|
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_file</span><span class="p">(</span><span class="s1">'podcast.xml'</span><span class="p">)</span>
|
||||||
</pre></div>
|
</pre></div>
|
||||||
</div>
|
</div>
|
||||||
<p>Of cause the extension has to be loaded for the FeedEntry objects as well but
|
<p>If the FeedGenerator class is used to load an extension, it is automatically
|
||||||
this is done automatically by the FeedGenerator for every feed entry if the
|
loaded for every feed entry as well. You can, however, load an extension for a
|
||||||
extension is loaded for the whole feed. You can, however, load an extension for
|
specific FeedEntry only by calling <cite>load_extension(…)</cite> on that entry.</p>
|
||||||
a specific FeedEntry by calling <cite>load_extension(…)</cite> on that entry. But this
|
<p>Even if extensions are loaded, they can be temporarily disabled during the feed
|
||||||
is a rather uncommon use.</p>
|
generation by calling the generating method with the keyword argument
|
||||||
<p>You can still produce a normal ATOM or RSS feed, even if you have loaded some
|
<cite>extensions</cite> set to <cite>False</cite>.</p>
|
||||||
plugins by temporary disabling them during the feed generation. This can be
|
|
||||||
done by calling the generating method with the keyword argument <cite>extensions</cite>
|
|
||||||
set to <cite>False</cite>.</p>
|
|
||||||
<p><strong>Custom Extensions</strong></p>
|
<p><strong>Custom Extensions</strong></p>
|
||||||
<p>If you want to load custom extension which are not part of the feedgen Python
|
<p>If you want to load custom extensions which are not part of the feedgen
|
||||||
package, you can use the method <cite>register_extension</cite> instead. You can directly
|
package, you can use the method <cite>register_extension</cite> instead. You can directly
|
||||||
pass the classes for the feed and the entry extension to this method meaning
|
pass the classes for the feed and the entry extension to this method meaning
|
||||||
that you can define them everywhere.</p>
|
that you can define them everywhere.</p>
|
||||||
|
@ -247,7 +240,7 @@ example for a whole feed generation process, you can find it in the
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
|
@ -6,13 +6,14 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>Python Module Index — python-feedgen 0.7.0 documentation</title>
|
<title>Python Module Index — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="_static/documentation_options.js"></script>
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="search.html" />
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
|
||||||
|
@ -20,7 +21,7 @@
|
||||||
|
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>Python Module Index</span></h2>
|
<h2 class="heading"><span>Python Module Index</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -104,7 +105,7 @@
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
10
search.html
10
search.html
|
@ -6,13 +6,15 @@
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
<title>Search — python-feedgen 0.7.0 documentation</title>
|
<title>Search — python-feedgen 0.8.0 documentation</title>
|
||||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||||
<script type="text/javascript" src="_static/documentation_options.js"></script>
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||||
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||||
<link rel="index" title="Index" href="genindex.html" />
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
<link rel="search" title="Search" href="#" />
|
<link rel="search" title="Search" href="#" />
|
||||||
|
@ -25,7 +27,7 @@
|
||||||
|
|
||||||
</head><body>
|
</head><body>
|
||||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
<span>python-feedgen 0.8.0 documentation</span></a></h1>
|
||||||
<h2 class="heading"><span>Search</span></h2>
|
<h2 class="heading"><span>Search</span></h2>
|
||||||
</div>
|
</div>
|
||||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||||
|
@ -73,7 +75,7 @@
|
||||||
|
|
||||||
<div class="footer" role="contentinfo">
|
<div class="footer" role="contentinfo">
|
||||||
© Copyright 2013-2016, Lars Kiesow.
|
© Copyright 2013-2016, Lars Kiesow.
|
||||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.2.
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
|
||||||
</div>
|
</div>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue