Documentation for v0.7.0
This commit is contained in:
Lars Kiesow
parent
6290638fe2
commit
f382690e48
20 changed files with 380 additions and 10669 deletions
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -398,6 +398,13 @@ table.field-list td, table.field-list th {
|
|||
margin: 0;
|
||||
}
|
||||
|
||||
.field-name {
|
||||
-moz-hyphens: manual;
|
||||
-ms-hyphens: manual;
|
||||
-webkit-hyphens: manual;
|
||||
hyphens: manual;
|
||||
}
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
|
|
@ -438,10 +445,14 @@ dd {
|
|||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dt:target, .highlighted {
|
||||
dt:target, span.highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
rect.highlighted {
|
||||
fill: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -45,7 +45,7 @@ jQuery.urlencode = encodeURIComponent;
|
|||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s == 'undefined')
|
||||
if (typeof s === 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
|
|
@ -66,29 +66,53 @@ jQuery.getQueryParameters = function(s) {
|
|||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node) {
|
||||
if (node.nodeType == 3) {
|
||||
function highlight(node, addItems) {
|
||||
if (node.nodeType === 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
|
||||
var span = document.createElement("span");
|
||||
var span;
|
||||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.className = className;
|
||||
}
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var bbox = span.getBBox();
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
var parentOfText = node.parentNode.parentNode;
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this);
|
||||
highlight(this, addItems);
|
||||
});
|
||||
}
|
||||
}
|
||||
return this.each(function() {
|
||||
highlight(this);
|
||||
var addItems = [];
|
||||
var result = this.each(function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
for (var i = 0; i < addItems.length; ++i) {
|
||||
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/*
|
||||
|
|
@ -131,21 +155,21 @@ var Documentation = {
|
|||
* i18n support
|
||||
*/
|
||||
TRANSLATIONS : {},
|
||||
PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
|
||||
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
|
||||
LOCALE : 'unknown',
|
||||
|
||||
// gettext and ngettext don't access this so that the functions
|
||||
// can safely bound to a different name (_ = Documentation.gettext)
|
||||
gettext : function(string) {
|
||||
var translated = Documentation.TRANSLATIONS[string];
|
||||
if (typeof translated == 'undefined')
|
||||
if (typeof translated === 'undefined')
|
||||
return string;
|
||||
return (typeof translated == 'string') ? translated : translated[0];
|
||||
return (typeof translated === 'string') ? translated : translated[0];
|
||||
},
|
||||
|
||||
ngettext : function(singular, plural, n) {
|
||||
var translated = Documentation.TRANSLATIONS[singular];
|
||||
if (typeof translated == 'undefined')
|
||||
if (typeof translated === 'undefined')
|
||||
return (n == 1) ? singular : plural;
|
||||
return translated[Documentation.PLURALEXPR(n)];
|
||||
},
|
||||
|
|
@ -180,7 +204,7 @@ var Documentation = {
|
|||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash)
|
||||
if (document.location.hash && $.browser.mozilla)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
|
|
@ -216,7 +240,7 @@ var Documentation = {
|
|||
var src = $(this).attr('src');
|
||||
var idnum = $(this).attr('id').substr(7);
|
||||
$('tr.cg-' + idnum).toggle();
|
||||
if (src.substr(-9) == 'minus.png')
|
||||
if (src.substr(-9) === 'minus.png')
|
||||
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
||||
else
|
||||
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
||||
|
|
@ -248,7 +272,7 @@ var Documentation = {
|
|||
var path = document.location.pathname;
|
||||
var parts = path.split(/\//);
|
||||
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
||||
if (this == '..')
|
||||
if (this === '..')
|
||||
parts.pop();
|
||||
});
|
||||
var url = parts.join('/');
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@
|
|||
* Braden Ewing <brewin@gmail.com>
|
||||
* Humdinger <humdingerb@gmail.com>
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
10308
_static/jquery-1.11.1.js
vendored
10308
_static/jquery-1.11.1.js
vendored
File diff suppressed because it is too large
Load diff
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -540,6 +540,9 @@ var Search = {
|
|||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
|
||||
if (suffix === undefined) {
|
||||
suffix = '.txt';
|
||||
}
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* sphinx.websupport utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
101
api.entry.html
101
api.entry.html
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.entry — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>feedgen.entry — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -29,9 +26,9 @@
|
|||
<link rel="next" title="feedgen.util" href="api.util.html" />
|
||||
<link rel="prev" title="feedgen.feed" href="api.feed.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.entry</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -76,8 +73,8 @@ node.</p>
|
|||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.author">
|
||||
<code class="descname">author</code><span class="sig-paren">(</span><em>author=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set autor data. An author element is a dict containing a
|
||||
name, an email adress and a uri. Name is mandatory for ATOM, email is
|
||||
<dd><p>Get or set author data. An author element is a dict containing a
|
||||
name, an email address and a uri. Name is mandatory for ATOM, email is
|
||||
mandatory for RSS.</p>
|
||||
<p>This method can be called with:
|
||||
- the fields of an author as keyword arguments
|
||||
|
|
@ -92,8 +89,8 @@ mandatory for RSS.</p>
|
|||
<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 last simple">
|
||||
<li><strong>author</strong> – Dict or list of dicts with author data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>author</strong> – Dict or list of dicts with author data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -132,8 +129,8 @@ is used. The scheme is used for the domain attribute in RSS.</p>
|
|||
<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>category</strong> – Dict or list of dicts with data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>category</strong> – Dict or list of dicts with data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -153,7 +150,7 @@ comments page for the item. This is a RSS only value.</p>
|
|||
<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"><strong>comments</strong> – URL to the comments page.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>comments</strong> – URL to the comments page.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">URL to the comments page.</td>
|
||||
</tr>
|
||||
|
|
@ -174,9 +171,9 @@ rss:description.</p>
|
|||
<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>content</strong> – The content of the feed entry.</li>
|
||||
<li><strong>src</strong> – Link to the entries content.</li>
|
||||
<li><strong>type</strong> – If type is CDATA content would not be escaped.</li>
|
||||
<li><strong>content</strong> – The content of the feed entry.</li>
|
||||
<li><strong>src</strong> – Link to the entries content.</li>
|
||||
<li><strong>type</strong> – If type is CDATA content would not be escaped.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -205,9 +202,9 @@ value.</p>
|
|||
<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>contributor</strong> – Dictionary or list of dictionaries with contributor
|
||||
<li><strong>contributor</strong> – Dictionary or list of dictionaries with contributor
|
||||
data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -230,8 +227,8 @@ which ATOM value is set when setting description.</p>
|
|||
<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>description</strong> – Description of the entry.</li>
|
||||
<li><strong>isSummary</strong> – If the description should be used as content or
|
||||
<li><strong>description</strong> – Description of the entry.</li>
|
||||
<li><strong>isSummary</strong> – If the description should be used as content or
|
||||
summary.</li>
|
||||
</ul>
|
||||
</td>
|
||||
|
|
@ -257,9 +254,9 @@ the feed. However, only the last one is used for RSS.</p>
|
|||
<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> – URL of the media object.</li>
|
||||
<li><strong>length</strong> – Size of the media in bytes.</li>
|
||||
<li><strong>type</strong> – Mimetype of the linked media.</li>
|
||||
<li><strong>url</strong> – URL of the media object.</li>
|
||||
<li><strong>length</strong> – Size of the media in bytes.</li>
|
||||
<li><strong>type</strong> – Mimetype of the linked media.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -280,8 +277,8 @@ identifies the item. This will also set atom:id.</p>
|
|||
<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>guid</strong> – Id of the entry.</li>
|
||||
<li><strong>permalink</strong> – If this is a permanent identifier for this item</li>
|
||||
<li><strong>guid</strong> – Id of the entry.</li>
|
||||
<li><strong>permalink</strong> – If this is a permanent identifier for this item</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -304,7 +301,7 @@ to False. Id is mandatory for an ATOM entry.</p>
|
|||
<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"><strong>id</strong> – New Id of the entry.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – New Id of the entry.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Id of the entry.</td>
|
||||
</tr>
|
||||
|
|
@ -362,8 +359,8 @@ the last link with rel=enclosure is used.</p>
|
|||
<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>link</strong> – Dict or list of dicts with data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>link</strong> – Dict or list of dicts with data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -383,9 +380,9 @@ the last link with rel=enclosure is used.</p>
|
|||
<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 last simple">
|
||||
<li><strong>name</strong> – Name of the extension to load.</li>
|
||||
<li><strong>atom</strong> – If the extension should be used for ATOM feeds.</li>
|
||||
<li><strong>rss</strong> – If the extension should be used for RSS feeds.</li>
|
||||
<li><strong>name</strong> – Name of the extension to load.</li>
|
||||
<li><strong>atom</strong> – If the extension should be used for ATOM feeds.</li>
|
||||
<li><strong>rss</strong> – If the extension should be used for RSS feeds.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -393,12 +390,22 @@ the last link with rel=enclosure is used.</p>
|
|||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.pubDate">
|
||||
<code class="descname">pubDate</code><span class="sig-paren">(</span><em>pubDate=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.pubDate" title="Permalink to this definition">¶</a></dt>
|
||||
<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(…)
|
||||
method.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.pubdate">
|
||||
<code class="descname">pubdate</code><span class="sig-paren">(</span><em>pubDate=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.pubdate" title="Permalink to this definition">¶</a></dt>
|
||||
<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>
|
||||
<p>pubdate(…) is deprected and may be removed in feedgen ≥ 0.8. Use
|
||||
pubDate(…) instead.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
|
|
@ -413,7 +420,7 @@ include timezone information.</p>
|
|||
<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"><strong>published</strong> – The creation date.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>published</strong> – The creation date.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Creation date as datetime.datetime</td>
|
||||
</tr>
|
||||
|
|
@ -430,10 +437,10 @@ include timezone information.</p>
|
|||
<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 last simple">
|
||||
<li><strong>namespace</strong> – namespace for the extension</li>
|
||||
<li><strong>extension_class_entry</strong> – Class of the entry extension to load.</li>
|
||||
<li><strong>atom</strong> – If the extension should be used for ATOM feeds.</li>
|
||||
<li><strong>rss</strong> – If the extension should be used for RSS feeds.</li>
|
||||
<li><strong>namespace</strong> – namespace for the extension</li>
|
||||
<li><strong>extension_class_entry</strong> – Class of the entry extension to load.</li>
|
||||
<li><strong>atom</strong> – If the extension should be used for ATOM feeds.</li>
|
||||
<li><strong>rss</strong> – If the extension should be used for RSS feeds.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -451,7 +458,7 @@ value will also set rss:copyright.</p>
|
|||
<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"><strong>rights</strong> – Rights information of the feed.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rights</strong> – Rights information of the feed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Rights information of the feed.</td>
|
||||
</tr>
|
||||
|
|
@ -473,13 +480,13 @@ summary, abstract, or excerpt of the entry. Summary is an ATOM only
|
|||
element and should be provided if there either is no content provided
|
||||
for the entry, or that content is not inline (i.e., contains a src
|
||||
attribute), or if the content is encoded in base64. This method will
|
||||
also set the rss:description field if it wasn’t previously set or
|
||||
also set the rss:description field if it wasn’t previously set or
|
||||
contains the old value of summary.</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"><strong>summary</strong> – Summary of the entries contents.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>summary</strong> – Summary of the entries contents.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Summary of the entries contents.</td>
|
||||
</tr>
|
||||
|
|
@ -497,7 +504,7 @@ and should not be blank.</p>
|
|||
<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"><strong>title</strong> – The new title of the entry.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>title</strong> – The new title of the entry.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The entriess title.</td>
|
||||
</tr>
|
||||
|
|
@ -509,13 +516,13 @@ and should not be blank.</p>
|
|||
<dt id="feedgen.entry.FeedEntry.ttl">
|
||||
<code class="descname">ttl</code><span class="sig-paren">(</span><em>ttl=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.ttl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the ttl value. It is an RSS only element. ttl stands for
|
||||
time to live. It’s a number of minutes that indicates how long a
|
||||
time to live. It’s a number of minutes that indicates how long a
|
||||
channel can be cached before refreshing from the source.</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"><strong>ttl</strong> – Integer value representing the time to live.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ttl</strong> – Integer value representing the time to live.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Time to live of of the entry.</td>
|
||||
</tr>
|
||||
|
|
@ -535,7 +542,7 @@ include timezone information.</p>
|
|||
<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"><strong>updated</strong> – The modification date.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>updated</strong> – The modification date.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Modification date as datetime.datetime</td>
|
||||
</tr>
|
||||
|
|
@ -563,7 +570,7 @@ include timezone information.</p>
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
193
api.feed.html
193
api.feed.html
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.feed — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>feedgen.feed — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -29,9 +26,9 @@
|
|||
<link rel="next" title="feedgen.entry" href="api.entry.html" />
|
||||
<link rel="prev" title="API Documentation" href="api.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.feed</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -68,17 +65,25 @@
|
|||
<dd><p>FeedGenerator for generating ATOM and RSS feeds.</p>
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.add_entry">
|
||||
<code class="descname">add_entry</code><span class="sig-paren">(</span><em>feedEntry=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.add_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">add_entry</code><span class="sig-paren">(</span><em>feedEntry=None</em>, <em>order='prepend'</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.add_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will add a new entry to the feed. If the feedEntry
|
||||
argument is omittet a new Entry object is created automatically. This
|
||||
is the prefered way to add new entries to a feed.</p>
|
||||
is the preferred way to add new entries to a feed.</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"><strong>feedEntry</strong> – FeedEntry object to add.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>feedEntry</strong> – FeedEntry object to add.</li>
|
||||
<li><strong>order</strong> – If <cite>prepend</cite> is chosen, the entry will be inserted
|
||||
at the beginning of the feed. If <cite>append</cite> is chosen,
|
||||
the entry will be appended to the feed.
|
||||
(default: <cite>prepend</cite>).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">FeedEntry object created or passed to this function.</td>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">FeedEntry object created or passed to this function.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -95,7 +100,7 @@ is the prefered way to add new entries to a feed.</p>
|
|||
<code class="descname">add_item</code><span class="sig-paren">(</span><em>item=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.add_item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will add a new item to the feed. If the item argument is
|
||||
omittet a new FeedEntry object is created automatically. This is just
|
||||
another name for add_entry(...)</p>
|
||||
another name for add_entry(…)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
|
|
@ -107,13 +112,13 @@ another name for add_entry(...)</p>
|
|||
<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 last simple">
|
||||
<li><strong>filename</strong> – Name of file to write or a file-like object or a URL.</li>
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
<li><strong>filename</strong> – Name of file to write or a file-like object or a URL.</li>
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
generation (default: enabled).</li>
|
||||
<li><strong>pretty</strong> – If the feed should be split into multiple lines and
|
||||
<li><strong>pretty</strong> – If the feed should be split into multiple lines and
|
||||
properly indented.</li>
|
||||
<li><strong>encoding</strong> – Encoding used in the XML file (default: UTF-8).</li>
|
||||
<li><strong>xml_declaration</strong> – If an XML declaration should be added to the
|
||||
<li><strong>encoding</strong> – Encoding used in the XML file (default: UTF-8).</li>
|
||||
<li><strong>xml_declaration</strong> – If an XML declaration should be added to the
|
||||
output (Default: enabled).</li>
|
||||
</ul>
|
||||
</td>
|
||||
|
|
@ -131,12 +136,12 @@ output (Default: enabled).</li>
|
|||
<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>pretty</strong> – If the feed should be split into multiple lines and
|
||||
<li><strong>pretty</strong> – If the feed should be split into multiple lines and
|
||||
properly indented.</li>
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
generation (default: enabled).</li>
|
||||
<li><strong>encoding</strong> – Encoding used in the XML file (default: UTF-8).</li>
|
||||
<li><strong>xml_declaration</strong> – If an XML declaration should be added to the
|
||||
<li><strong>encoding</strong> – Encoding used in the XML file (default: UTF-8).</li>
|
||||
<li><strong>xml_declaration</strong> – If an XML declaration should be added to the
|
||||
output (Default: enabled).</li>
|
||||
</ul>
|
||||
</td>
|
||||
|
|
@ -174,8 +179,8 @@ is mandatory for RSS.</p>
|
|||
<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>author</strong> – Dictionary or list of dictionaries with author data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>author</strong> – Dictionary or list of dictionaries with author data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -222,8 +227,8 @@ is used. The scheme is used for the domain attribute in RSS.</p>
|
|||
<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>link</strong> – Dict or list of dicts with data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>link</strong> – Dict or list of dicts with data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -245,11 +250,11 @@ can be implemented in HTTP-POST, XML-RPC or SOAP 1.1.</p>
|
|||
<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>domain</strong> – The domain where the webservice can be found.</li>
|
||||
<li><strong>port</strong> – The port the webservice listens to.</li>
|
||||
<li><strong>path</strong> – The path of the webservice.</li>
|
||||
<li><strong>registerProcedure</strong> – The procedure to call.</li>
|
||||
<li><strong>protocol</strong> – Can be either HTTP-POST, XML-RPC or SOAP 1.1.</li>
|
||||
<li><strong>domain</strong> – The domain where the webservice can be found.</li>
|
||||
<li><strong>port</strong> – The port the webservice listens to.</li>
|
||||
<li><strong>path</strong> – The path of the webservice.</li>
|
||||
<li><strong>registerProcedure</strong> – The procedure to call.</li>
|
||||
<li><strong>protocol</strong> – Can be either HTTP-POST, XML-RPC or SOAP 1.1.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -278,9 +283,9 @@ value.</p>
|
|||
<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>contributor</strong> – Dictionary or list of dictionaries with contributor
|
||||
<li><strong>contributor</strong> – Dictionary or list of dictionaries with contributor
|
||||
data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -300,7 +305,7 @@ value will also set the atom:rights value.</p>
|
|||
<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"><strong>copyright</strong> – The copyright notice.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>copyright</strong> – The copyright notice.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The copyright notice.</td>
|
||||
</tr>
|
||||
|
|
@ -319,7 +324,7 @@ this will also set atom:subtitle.</p>
|
|||
<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"><strong>description</strong> – Description of the channel.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>description</strong> – Description of the channel.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Description of the channel.</td>
|
||||
</tr>
|
||||
|
|
@ -340,7 +345,7 @@ what it is.</p>
|
|||
<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"><strong>docs</strong> – URL of the format documentation.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>docs</strong> – URL of the format documentation.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">URL of the format documentation.</td>
|
||||
</tr>
|
||||
|
|
@ -358,7 +363,7 @@ automatically create the FeedEntry objects.</p>
|
|||
<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"><strong>entry</strong> – FeedEntry object or list of FeedEntry objects.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>entry</strong> – FeedEntry object or list of FeedEntry objects.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List ob all feed entries.</td>
|
||||
</tr>
|
||||
|
|
@ -378,9 +383,9 @@ feed.</p>
|
|||
<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 last simple">
|
||||
<li><strong>generator</strong> – Software used to create the feed.</li>
|
||||
<li><strong>version</strong> – Version of the software.</li>
|
||||
<li><strong>uri</strong> – URI the software can be found.</li>
|
||||
<li><strong>generator</strong> – Software used to create the feed.</li>
|
||||
<li><strong>version</strong> – Version of the software.</li>
|
||||
<li><strong>uri</strong> – URI the software can be found.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -398,7 +403,7 @@ square. This is an ATOM only value.</p>
|
|||
<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"><strong>icon</strong> – URI of the feeds icon.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>icon</strong> – URI of the feeds icon.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">URI of the feeds icon.</td>
|
||||
</tr>
|
||||
|
|
@ -411,13 +416,13 @@ square. This is an ATOM only value.</p>
|
|||
<code class="descname">id</code><span class="sig-paren">(</span><em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the feed id which identifies the feed using a universally
|
||||
unique and permanent URI. If you have a long-term, renewable lease on
|
||||
your Internet domain name, then you can feel free to use your website’s
|
||||
your Internet domain name, then you can feel free to use your website’s
|
||||
address. This field is for ATOM only. It is mandatory for ATOM.</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"><strong>id</strong> – New Id of the ATOM feed.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – New Id of the ATOM feed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Id of the feed.</td>
|
||||
</tr>
|
||||
|
|
@ -435,14 +440,14 @@ atom:logo.</p>
|
|||
<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> – The URL of a GIF, JPEG or PNG image.</li>
|
||||
<li><strong>title</strong> – Describes the image. The default value is the feeds
|
||||
<li><strong>url</strong> – The URL of a GIF, JPEG or PNG image.</li>
|
||||
<li><strong>title</strong> – Describes the image. The default value is the feeds
|
||||
title.</li>
|
||||
<li><strong>link</strong> – URL of the site the image will link to. The default is to
|
||||
<li><strong>link</strong> – URL of the site the image will link to. The default is to
|
||||
use the feeds first altertate link.</li>
|
||||
<li><strong>width</strong> – Width of the image in pixel. The maximum is 144.</li>
|
||||
<li><strong>height</strong> – The height of the image. The maximum is 400.</li>
|
||||
<li><strong>description</strong> – Title of the link.</li>
|
||||
<li><strong>width</strong> – Width of the image in pixel. The maximum is 144.</li>
|
||||
<li><strong>height</strong> – The height of the image. The maximum is 400.</li>
|
||||
<li><strong>description</strong> – Title of the link.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -456,7 +461,7 @@ use the feeds first altertate link.</li>
|
|||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.item">
|
||||
<code class="descname">item</code><span class="sig-paren">(</span><em>item=None</em>, <em>replace=False</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set feed items. This is just another name for entry(...)</p>
|
||||
<dd><p>Get or set feed items. This is just another name for entry(…)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
|
|
@ -472,7 +477,7 @@ The value should be an IETF language tag.</p>
|
|||
<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"><strong>language</strong> – Language of the feed.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>language</strong> – Language of the feed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Language of the feed.</td>
|
||||
</tr>
|
||||
|
|
@ -497,7 +502,7 @@ include timezone information.</p>
|
|||
<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"><strong>lastBuildDate</strong> – The modification date.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>lastBuildDate</strong> – The modification date.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Modification date as datetime.datetime</td>
|
||||
</tr>
|
||||
|
|
@ -553,8 +558,8 @@ display purposes.</p>
|
|||
<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>link</strong> – Dict or list of dicts with data.</li>
|
||||
<li><strong>replace</strong> – If old links are to be replaced (default: False)</li>
|
||||
<li><strong>link</strong> – Dict or list of dicts with data.</li>
|
||||
<li><strong>replace</strong> – If old links are to be replaced (default: False)</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -579,9 +584,9 @@ display purposes.</p>
|
|||
<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 last simple">
|
||||
<li><strong>name</strong> – Name of the extension to load.</li>
|
||||
<li><strong>atom</strong> – If the extension should be used for ATOM feeds.</li>
|
||||
<li><strong>rss</strong> – If the extension should be used for RSS feeds.</li>
|
||||
<li><strong>name</strong> – Name of the extension to load.</li>
|
||||
<li><strong>atom</strong> – If the extension should be used for ATOM feeds.</li>
|
||||
<li><strong>rss</strong> – If the extension should be used for RSS feeds.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -600,7 +605,7 @@ rss:image value.</p>
|
|||
<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"><strong>logo</strong> – Logo of the feed.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>logo</strong> – Logo of the feed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Logo of the feed.</td>
|
||||
</tr>
|
||||
|
|
@ -618,9 +623,9 @@ value.</p>
|
|||
<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"><strong>managingEditor</strong> – Email adress of the managing editor.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>managingEditor</strong> – Email address of the managing editor.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Email adress of the managing editor.</td>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Email address of the managing editor.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -631,7 +636,7 @@ value.</p>
|
|||
<code class="descname">pubDate</code><span class="sig-paren">(</span><em>pubDate=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.pubDate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the publication date for the content in the channel. For
|
||||
example, the New York Times publishes on a daily basis, the publication
|
||||
date flips once every 24 hours. That’s when the pubDate of the channel
|
||||
date flips once every 24 hours. That’s when the pubDate of the channel
|
||||
changes.</p>
|
||||
<p>The value can either be a string which will automatically be parsed or
|
||||
a datetime.datetime object. In any case it is necessary that the value
|
||||
|
|
@ -641,7 +646,7 @@ include timezone information.</p>
|
|||
<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"><strong>pubDate</strong> – The publication date.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pubDate</strong> – The publication date.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Publication date as datetime.datetime</td>
|
||||
</tr>
|
||||
|
|
@ -665,11 +670,11 @@ value.</p>
|
|||
<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 last simple">
|
||||
<li><strong>namespace</strong> – namespace for the extension</li>
|
||||
<li><strong>extension_class_feed</strong> – Class of the feed extension to load.</li>
|
||||
<li><strong>extension_class_entry</strong> – Class of the entry extension to load</li>
|
||||
<li><strong>atom</strong> – If the extension should be used for ATOM feeds.</li>
|
||||
<li><strong>rss</strong> – If the extension should be used for RSS feeds.</li>
|
||||
<li><strong>namespace</strong> – namespace for the extension</li>
|
||||
<li><strong>extension_class_feed</strong> – Class of the feed extension to load.</li>
|
||||
<li><strong>extension_class_entry</strong> – Class of the entry extension to load</li>
|
||||
<li><strong>atom</strong> – If the extension should be used for ATOM feeds.</li>
|
||||
<li><strong>rss</strong> – If the extension should be used for RSS feeds.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -686,7 +691,7 @@ FeedEntry object to remove or the index of the entry as argument.</p>
|
|||
<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"><strong>entry</strong> – Entry or index of entry to remove.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>entry</strong> – Entry or index of entry to remove.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -709,7 +714,7 @@ value will also set rss:copyright.</p>
|
|||
<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"><strong>rights</strong> – Rights information of the feed.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rights</strong> – Rights information of the feed.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -724,13 +729,13 @@ value will also set rss:copyright.</p>
|
|||
<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 last simple">
|
||||
<li><strong>filename</strong> – Name of file to write or a file-like object or a URL.</li>
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
<li><strong>filename</strong> – Name of file to write or a file-like object or a URL.</li>
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
generation (default: enabled).</li>
|
||||
<li><strong>pretty</strong> – If the feed should be split into multiple lines and
|
||||
<li><strong>pretty</strong> – If the feed should be split into multiple lines and
|
||||
properly indented.</li>
|
||||
<li><strong>encoding</strong> – Encoding used in the XML file (default: UTF-8).</li>
|
||||
<li><strong>xml_declaration</strong> – If an XML declaration should be added to the
|
||||
<li><strong>encoding</strong> – Encoding used in the XML file (default: UTF-8).</li>
|
||||
<li><strong>xml_declaration</strong> – If an XML declaration should be added to the
|
||||
output (Default: enabled).</li>
|
||||
</ul>
|
||||
</td>
|
||||
|
|
@ -748,12 +753,12 @@ output (Default: enabled).</li>
|
|||
<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>pretty</strong> – If the feed should be split into multiple lines and
|
||||
<li><strong>pretty</strong> – If the feed should be split into multiple lines and
|
||||
properly indented.</li>
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
generation (default: enabled).</li>
|
||||
<li><strong>encoding</strong> – Encoding used in the XML file (default: UTF-8).</li>
|
||||
<li><strong>xml_declaration</strong> – If an XML declaration should be added to the
|
||||
<li><strong>encoding</strong> – Encoding used in the XML file (default: UTF-8).</li>
|
||||
<li><strong>xml_declaration</strong> – If an XML declaration should be added to the
|
||||
output (Default: enabled).</li>
|
||||
</ul>
|
||||
</td>
|
||||
|
|
@ -774,14 +779,14 @@ details have a look at the <a class="reference external" href="https://docs.pyth
|
|||
<dd><p>Set or get the value of skipDays, a hint for aggregators telling
|
||||
them which days they can skip This is an RSS only value.</p>
|
||||
<p>This method can be called with a day name or a list of day names. The
|
||||
days are represented as strings from ‘Monday’ to ‘Sunday’.</p>
|
||||
days are represented as strings from ‘Monday’ to ‘Sunday’.</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>hours</strong> – List of days the feedreaders should not check the feed.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>hours</strong> – List of days the feedreaders should not check the feed.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -804,8 +809,8 @@ are represented as integer values from 0 to 23.</p>
|
|||
<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>hours</strong> – List of hours the feedreaders should not check the feed.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>hours</strong> – List of hours the feedreaders should not check the feed.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -826,7 +831,7 @@ will also set the value for rss:description.</p>
|
|||
<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"><strong>subtitle</strong> – The subtitle of the feed.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>subtitle</strong> – The subtitle of the feed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The subtitle of the feed.</td>
|
||||
</tr>
|
||||
|
|
@ -846,10 +851,10 @@ feedback. Most aggregators ignore it.</p>
|
|||
<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>title</strong> – The label of the Submit button in the text input area.</li>
|
||||
<li><strong>description</strong> – Explains the text input area.</li>
|
||||
<li><strong>name</strong> – The name of the text object in the text input area.</li>
|
||||
<li><strong>link</strong> – The URL of the CGI script that processes text input
|
||||
<li><strong>title</strong> – The label of the Submit button in the text input area.</li>
|
||||
<li><strong>description</strong> – Explains the text input area.</li>
|
||||
<li><strong>name</strong> – The name of the text object in the text input area.</li>
|
||||
<li><strong>link</strong> – The URL of the CGI script that processes text input
|
||||
requests.</li>
|
||||
</ul>
|
||||
</td>
|
||||
|
|
@ -872,7 +877,7 @@ not be blank.</p>
|
|||
<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"><strong>title</strong> – The new title of the feed.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>title</strong> – The new title of the feed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The feeds title.</td>
|
||||
</tr>
|
||||
|
|
@ -884,13 +889,13 @@ not be blank.</p>
|
|||
<dt id="feedgen.feed.FeedGenerator.ttl">
|
||||
<code class="descname">ttl</code><span class="sig-paren">(</span><em>ttl=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.ttl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the ttl value. It is an RSS only element. ttl stands for
|
||||
time to live. It’s a number of minutes that indicates how long a
|
||||
time to live. It’s a number of minutes that indicates how long a
|
||||
channel can be cached before refreshing from the source.</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"><strong>ttl</strong> – Integer value indicating how long the channel may be
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ttl</strong> – Integer value indicating how long the channel may be
|
||||
cached.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Time to live.</td>
|
||||
|
|
@ -916,7 +921,7 @@ include timezone information.</p>
|
|||
<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"><strong>updated</strong> – The modification date.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>updated</strong> – The modification date.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Modification date as datetime.datetime</td>
|
||||
</tr>
|
||||
|
|
@ -934,7 +939,7 @@ feed. This is an RSS only value.</p>
|
|||
<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"><strong>webMaster</strong> – Email address of the webmaster.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>webMaster</strong> – Email address of the webmaster.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Email address of the webmaster.</td>
|
||||
</tr>
|
||||
|
|
@ -962,7 +967,7 @@ feed. This is an RSS only value.</p>
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
23
api.html
23
api.html
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>API Documentation — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>API Documentation — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -29,9 +26,9 @@
|
|||
<link rel="next" title="feedgen.feed" href="api.feed.html" />
|
||||
<link rel="prev" title="Feedgenerator" href="index.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>API Documentation</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -117,7 +114,7 @@ instantiation of the FeedEntry object:</p>
|
|||
<span class="gp">>>> </span><span class="n">fe</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s1">'The First Episode'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The FeedGenerators method add_entry(...) without argument provides will
|
||||
<p>The FeedGenerators method add_entry(…) without argument provides will
|
||||
automatically generate a new FeedEntry object, append it to the feeds
|
||||
internal list of entries and return it, so that additional data can be
|
||||
added.</p>
|
||||
|
|
@ -132,9 +129,9 @@ XML structure of the feeds. Extensions can be loaded like this:</p>
|
|||
<p>This will try to load the extension “someext” from the file
|
||||
<cite>ext/someext.py</cite>. It is required that <cite>someext.py</cite> contains a class named
|
||||
“SomextExtension” which is required to have at least the two methods
|
||||
<cite>extend_rss(...)</cite> and <cite>extend_atom(...)</cite>. Although not required, it is
|
||||
<cite>extend_rss(…)</cite> and <cite>extend_atom(…)</cite>. Although not required, it is
|
||||
strongly suggested to use BaseExtension from <cite>ext/base.py</cite> as superclass.</p>
|
||||
<p><cite>load_extension(‘someext’, ...)</cite> will also try to load a class named
|
||||
<p><cite>load_extension(‘someext’, …)</cite> will also try to load a class named
|
||||
“SomextEntryExtension” for every entry of the feed. This class can be
|
||||
located either in the same file as SomextExtension or in
|
||||
<cite>ext/someext_entry.py</cite> which is suggested especially for large extensions.</p>
|
||||
|
|
@ -159,7 +156,7 @@ RSS feed with some additional elements for ITunes.</p>
|
|||
<p>Of cause the extension has to be loaded for the FeedEntry objects as well
|
||||
but this is done automatically by the FeedGenerator for every feed entry if
|
||||
the extension is loaded for the whole feed. You can, however, load an
|
||||
extension for a specific FeedEntry by calling <cite>load_extension(...)</cite> on that
|
||||
extension for a specific FeedEntry by calling <cite>load_extension(…)</cite> on that
|
||||
entry. But this is a rather uncommon use.</p>
|
||||
<p>Of cause you can still produce a normal ATOM or RSS feed, even if you have
|
||||
loaded some plugins by temporary disabling them during the feed generation.
|
||||
|
|
@ -205,7 +202,7 @@ This can be done by calling the generating method with the keyword argument
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.util — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>feedgen.util — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -29,9 +26,9 @@
|
|||
<link rel="next" title="feedgen.ext.base" href="ext/api.ext.base.html" />
|
||||
<link rel="prev" title="feedgen.entry" href="api.entry.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.util</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -74,12 +71,12 @@ of a specific key are ok.</p>
|
|||
<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>val</strong> – Dictionaries to check.</li>
|
||||
<li><strong>allowed</strong> – Set of allowed keys.</li>
|
||||
<li><strong>required</strong> – Set of required keys.</li>
|
||||
<li><strong>allowed_values</strong> – Dictionary with keys and sets of their allowed
|
||||
<li><strong>val</strong> – Dictionaries to check.</li>
|
||||
<li><strong>allowed</strong> – Set of allowed keys.</li>
|
||||
<li><strong>required</strong> – Set of required keys.</li>
|
||||
<li><strong>allowed_values</strong> – Dictionary with keys and sets of their allowed
|
||||
values.</li>
|
||||
<li><strong>defaults</strong> – Dictionary with default values.</li>
|
||||
<li><strong>defaults</strong> – Dictionary with default values.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -92,7 +89,7 @@ values.</li>
|
|||
|
||||
<dl class="function">
|
||||
<dt id="feedgen.util.formatRFC2822">
|
||||
<code class="descclassname">feedgen.util.</code><code class="descname">formatRFC2822</code><span class="sig-paren">(</span><em>d</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.util.formatRFC2822" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">feedgen.util.</code><code class="descname">formatRFC2822</code><span class="sig-paren">(</span><em>date</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.util.formatRFC2822" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Make sure the locale setting do not interfere with the time format.</p>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -114,7 +111,7 @@ values.</li>
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.base — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>feedgen.ext.base — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -29,9 +26,9 @@
|
|||
<link rel="next" title="feedgen.ext.dc" href="api.ext.dc.html" />
|
||||
<link rel="prev" title="feedgen.util" href="../api.util.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.base</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -83,7 +80,7 @@ fields.</p>
|
|||
<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"><strong>feed</strong> – The feed xml root element.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>feed</strong> – The feed xml root element.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The feed root element.</td>
|
||||
</tr>
|
||||
|
|
@ -105,7 +102,7 @@ fields.</p>
|
|||
<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"><strong>feed</strong> – The feed xml root element.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>feed</strong> – The feed xml root element.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The feed root element.</td>
|
||||
</tr>
|
||||
|
|
@ -133,7 +130,7 @@ fields.</p>
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.dc — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>feedgen.ext.dc — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -29,9 +26,9 @@
|
|||
<link rel="next" title="feedgen.ext.podcast" href="api.ext.podcast.html" />
|
||||
<link rel="prev" title="feedgen.ext.base" href="api.ext.base.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.dc</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -81,8 +78,8 @@ making contributions to the resource.</p>
|
|||
<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>contributor</strong> – Contributor or list of contributors.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set contributors (deault: False).</li>
|
||||
<li><strong>contributor</strong> – Contributor or list of contributors.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set contributors (deault: False).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -114,8 +111,8 @@ identifiers such as sets of coordinates or date ranges.</p>
|
|||
<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>coverage</strong> – Coverage of the feed.</li>
|
||||
<li><strong>replace</strong> – Replace already set coverage (default: True).</li>
|
||||
<li><strong>coverage</strong> – Coverage of the feed.</li>
|
||||
<li><strong>replace</strong> – Replace already set coverage (default: True).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -138,8 +135,8 @@ for making the resource.</p>
|
|||
<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>creator</strong> – Creator or list of creators.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set creators (deault: False).</li>
|
||||
<li><strong>creator</strong> – Creator or list of creators.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set creators (deault: False).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -162,8 +159,8 @@ associated with an event in the lifecycle of the resource.</p>
|
|||
<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>date</strong> – Date or list of dates.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set dates (deault: True).</li>
|
||||
<li><strong>date</strong> – Date or list of dates.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set dates (deault: True).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -185,8 +182,8 @@ associated with an event in the lifecycle of the resource.</p>
|
|||
<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>description</strong> – Description or list of descriptions.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set descriptions (deault: True).</li>
|
||||
<li><strong>description</strong> – Description or list of descriptions.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set descriptions (deault: True).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -209,8 +206,8 @@ medium, or dimensions of the resource.</p>
|
|||
<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>format</strong> – Format of the resource or list of formats.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set format (deault: True).</li>
|
||||
<li><strong>format</strong> – Format of the resource or list of formats.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set format (deault: True).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -233,8 +230,8 @@ reference to the resource within a given context.</p>
|
|||
<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>identifier</strong> – Identifier of the resource or list of identifiers.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set identifier (deault: True).</li>
|
||||
<li><strong>identifier</strong> – Identifier of the resource or list of identifiers.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set identifier (deault: True).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -257,8 +254,8 @@ resource.</p>
|
|||
<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>language</strong> – Language or list of languages.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set languages (deault: True).</li>
|
||||
<li><strong>language</strong> – Language or list of languages.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set languages (deault: True).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -281,8 +278,8 @@ making the resource available.</p>
|
|||
<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>publisher</strong> – Publisher or list of publishers.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set publishers (deault: False).</li>
|
||||
<li><strong>publisher</strong> – Publisher or list of publishers.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set publishers (deault: False).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -304,8 +301,8 @@ making the resource available.</p>
|
|||
<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>relation</strong> – Relation or list of relations.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set relations (deault: False).</li>
|
||||
<li><strong>relation</strong> – Relation or list of relations.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set relations (deault: False).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -328,8 +325,8 @@ held in and over the resource.</p>
|
|||
<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>rights</strong> – Rights information or list of rights information.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set rightss (deault: False).</li>
|
||||
<li><strong>rights</strong> – Rights information or list of rights information.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set rightss (deault: False).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -356,8 +353,8 @@ system.</p>
|
|||
<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>source</strong> – Source or list of sources.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set sources (deault: False).</li>
|
||||
<li><strong>source</strong> – Source or list of sources.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set sources (deault: False).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -379,8 +376,8 @@ system.</p>
|
|||
<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>subject</strong> – Subject or list of subjects.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set subjects (deault: False).</li>
|
||||
<li><strong>subject</strong> – Subject or list of subjects.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set subjects (deault: False).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -402,8 +399,8 @@ system.</p>
|
|||
<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>title</strong> – Title or list of titles.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set titles (deault: False).</li>
|
||||
<li><strong>title</strong> – Title or list of titles.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set titles (deault: False).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -426,8 +423,8 @@ resource.</p>
|
|||
<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>type</strong> – Type or list of types.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set types (deault: False).</li>
|
||||
<li><strong>type</strong> – Type or list of types.</li>
|
||||
<li><strong>replace</strong> – Replace alredy set types (deault: False).</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -446,7 +443,7 @@ resource.</p>
|
|||
<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"><strong>atom_feed</strong> – The feed root element</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>atom_feed</strong> – The feed root element</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The feed root element</td>
|
||||
</tr>
|
||||
|
|
@ -462,7 +459,7 @@ resource.</p>
|
|||
<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"><strong>rss_feed</strong> – The feed root element</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rss_feed</strong> – The feed root element</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The feed root element.</td>
|
||||
</tr>
|
||||
|
|
@ -484,7 +481,7 @@ resource.</p>
|
|||
<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"><strong>entry</strong> – An atom entry element.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>entry</strong> – An atom entry element.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The entry element.</td>
|
||||
</tr>
|
||||
|
|
@ -500,7 +497,7 @@ resource.</p>
|
|||
<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"><strong>item</strong> – A RSS item element.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> – A RSS item element.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The item element.</td>
|
||||
</tr>
|
||||
|
|
@ -534,7 +531,7 @@ resource.</p>
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.podcast — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>feedgen.ext.podcast — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -29,9 +26,9 @@
|
|||
<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" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.podcast</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -92,7 +89,7 @@ feed level, iTunes will use the contents of <managingEditor>.</p>
|
|||
<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"><strong>itunes_author</strong> – The author of the podcast.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_author</strong> – The author of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The author of the podcast.</td>
|
||||
</tr>
|
||||
|
|
@ -109,7 +106,7 @@ entire podcast from appearing in the iTunes podcast directory.</p>
|
|||
<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"><strong>itunes_block</strong> – Block the podcast.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_block</strong> – Block the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast is blocked.</td>
|
||||
</tr>
|
||||
|
|
@ -153,9 +150,9 @@ category is called more than once.</p>
|
|||
<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>itunes_category</strong> – Dictionary or list of dictionaries with
|
||||
<li><strong>itunes_category</strong> – Dictionary or list of dictionaries with
|
||||
itunes_category data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -164,7 +161,7 @@ itunes_category data.</li>
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>—</p>
|
||||
<p>—</p>
|
||||
<p><strong>Important note about deprecated parameter syntax:</strong> Old version of
|
||||
the feedgen did only support one category plus one subcategory which
|
||||
would be passed to this ducntion as first two parameters. For
|
||||
|
|
@ -177,7 +174,7 @@ be removed at any time.</p>
|
|||
<code class="descname">itunes_complete</code><span class="sig-paren">(</span><em>itunes_complete=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_complete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:complete value of the podcast. This tag can be
|
||||
used to indicate the completion of a podcast.</p>
|
||||
<p>If you populate this tag with “yes”, you are indicating that no more
|
||||
<p>If you populate this tag with “yes”, you are indicating that no more
|
||||
episodes will be added to the podcast. If the <itunes:complete> tag is
|
||||
present and has any other value (e.g. “no”), it will have no effect on
|
||||
the podcast.</p>
|
||||
|
|
@ -185,7 +182,7 @@ the podcast.</p>
|
|||
<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"><strong>itunes_complete</strong> – If the podcast is complete.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_complete</strong> – If the podcast is complete.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast is complete.</td>
|
||||
</tr>
|
||||
|
|
@ -198,20 +195,20 @@ the podcast.</p>
|
|||
<code class="descname">itunes_explicit</code><span class="sig-paren">(</span><em>itunes_explicit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_explicit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or the the itunes:explicit value of the podcast. This tag should
|
||||
be used to indicate whether your podcast contains explicit material.
|
||||
The three values for this tag are “yes”, “no”, and “clean”.</p>
|
||||
<p>If you populate this tag with “yes”, an “explicit” parental advisory
|
||||
The three values for this tag are “yes”, “no”, and “clean”.</p>
|
||||
<p>If you populate this tag with “yes”, an “explicit” parental advisory
|
||||
graphic will appear next to your podcast artwork on the iTunes Store
|
||||
and in the Name column in iTunes. If the value is “clean”, the parental
|
||||
and in the Name column in iTunes. If the value is “clean”, the parental
|
||||
advisory type is considered Clean, meaning that no explicit language or
|
||||
adult content is included anywhere in the episodes, and a “clean”
|
||||
adult content is included anywhere in the episodes, and a “clean”
|
||||
graphic will appear. If the explicit tag is present and has any other
|
||||
value (e.g., “no”), you see no indicator — blank is the default
|
||||
value (e.g., “no”), you see no indicator — blank is the default
|
||||
advisory type.</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"><strong>itunes_explicit</strong> – If the podcast contains explicit material.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_explicit</strong> – If the podcast contains explicit material.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast contains explicit material.</td>
|
||||
</tr>
|
||||
|
|
@ -229,7 +226,7 @@ which is different from what is specified for the standard RSS image
|
|||
tag. In order for a podcast to be eligible for an iTunes Store feature,
|
||||
the accompanying image must be at least 1400x1400 pixels.</p>
|
||||
<p>iTunes supports images in JPEG and PNG formats with an RGB color space
|
||||
(CMYK is not supported). The URL must end in ”.jpg” or ”.png”. If the
|
||||
(CMYK is not supported). The URL must end in “.jpg” or “.png”. If the
|
||||
<itunes:image> tag is not present, iTunes will use the contents of the
|
||||
RSS image tag.</p>
|
||||
<p>If you change your podcast’s image, also change the file’s name. iTunes
|
||||
|
|
@ -240,7 +237,7 @@ requests for iTS to be able to automatically update your cover art.</p>
|
|||
<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"><strong>itunes_image</strong> – Image of the podcast.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_image</strong> – Image of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Image of the podcast.</td>
|
||||
</tr>
|
||||
|
|
@ -260,7 +257,7 @@ updated the directory with the new feed URL.</p>
|
|||
<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"><strong>itunes_new_feed_url</strong> – New feed URL.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_new_feed_url</strong> – New feed URL.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">New feed URL.</td>
|
||||
</tr>
|
||||
|
|
@ -279,7 +276,7 @@ displayed.</p>
|
|||
<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"><strong>itunes_owner</strong> – The owner of the feed.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_owner</strong> – The owner of the feed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data of the owner of the feed.</td>
|
||||
</tr>
|
||||
|
|
@ -297,7 +294,7 @@ displays best if it is only a few words long.</p>
|
|||
<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"><strong>itunes_subtitle</strong> – Subtitle of the podcast.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_subtitle</strong> – Subtitle of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Subtitle of the podcast.</td>
|
||||
</tr>
|
||||
|
|
@ -309,8 +306,8 @@ displays best if it is only a few words long.</p>
|
|||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_summary">
|
||||
<code class="descname">itunes_summary</code><span class="sig-paren">(</span><em>itunes_summary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:summary value for the podcast. The contents of
|
||||
this tag are shown in a separate window that appears when the “circled
|
||||
i” in the Description column is clicked. It also appears on the iTunes
|
||||
this tag are shown in a separate window that appears when the “circled
|
||||
i” in the Description column is clicked. It also appears on the iTunes
|
||||
page for your podcast. This field can be up to 4000 characters. If
|
||||
<cite><itunes:summary></cite> is not included, the contents of the <description>
|
||||
tag are used.</p>
|
||||
|
|
@ -318,7 +315,7 @@ tag are used.</p>
|
|||
<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"><strong>itunes_summary</strong> – Summary of the podcast.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_summary</strong> – Summary of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Summary of the podcast.</td>
|
||||
</tr>
|
||||
|
|
@ -346,7 +343,7 @@ tag are used.</p>
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.podcast_entry — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>feedgen.ext.podcast_entry — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -29,9 +26,9 @@
|
|||
<link rel="next" title="feedgen.ext.torrent" href="api.ext.torrent.html" />
|
||||
<link rel="prev" title="feedgen.ext.podcast" href="api.ext.podcast.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.podcast_entry</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -75,7 +72,7 @@
|
|||
<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"><strong>feed</strong> – The RSS item XML element to use.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>feed</strong> – The RSS item XML element to use.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -93,7 +90,7 @@ contents of <managingEditor>.</p>
|
|||
<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"><strong>itunes_author</strong> – The author of the podcast.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_author</strong> – The author of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The author of the podcast.</td>
|
||||
</tr>
|
||||
|
|
@ -110,7 +107,7 @@ from appearing in the iTunes podcast directory.</p>
|
|||
<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"><strong>itunes_block</strong> – Block podcast episodes.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_block</strong> – Block podcast episodes.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast episode is blocked.</td>
|
||||
</tr>
|
||||
|
|
@ -133,7 +130,7 @@ are present, the numbers farthest to the right are ignored.</p>
|
|||
<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"><strong>itunes_duration</strong> – Duration of the podcast episode.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_duration</strong> – Duration of the podcast episode.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Duration of the podcast episode.</td>
|
||||
</tr>
|
||||
|
|
@ -146,21 +143,21 @@ are present, the numbers farthest to the right are ignored.</p>
|
|||
<code class="descname">itunes_explicit</code><span class="sig-paren">(</span><em>itunes_explicit=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_explicit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or the the itunes:explicit value of the podcast episode. This
|
||||
tag should be used to indicate whether your podcast episode contains
|
||||
explicit material. The three values for this tag are “yes”, “no”, and
|
||||
“clean”.</p>
|
||||
<p>If you populate this tag with “yes”, an “explicit” parental advisory
|
||||
explicit material. The three values for this tag are “yes”, “no”, and
|
||||
“clean”.</p>
|
||||
<p>If you populate this tag with “yes”, an “explicit” parental advisory
|
||||
graphic will appear next to your podcast artwork on the iTunes Store
|
||||
and in the Name column in iTunes. If the value is “clean”, the parental
|
||||
and in the Name column in iTunes. If the value is “clean”, the parental
|
||||
advisory type is considered Clean, meaning that no explicit language or
|
||||
adult content is included anywhere in the episodes, and a “clean”
|
||||
adult content is included anywhere in the episodes, and a “clean”
|
||||
graphic will appear. If the explicit tag is present and has any other
|
||||
value (e.g., “no”), you see no indicator — blank is the default
|
||||
value (e.g., “no”), you see no indicator — blank is the default
|
||||
advisory type.</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"><strong>itunes_explicit</strong> – If the podcast episode contains explicit
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_explicit</strong> – If the podcast episode contains explicit
|
||||
material.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast episode contains explicit material.</td>
|
||||
|
|
@ -180,7 +177,7 @@ standard RSS image tag. In order for a podcast to be eligible for an
|
|||
iTunes Store feature, the accompanying image must be at least 1400x1400
|
||||
pixels.</p>
|
||||
<p>iTunes supports images in JPEG and PNG formats with an RGB color space
|
||||
(CMYK is not supported). The URL must end in ”.jpg” or ”.png”. If the
|
||||
(CMYK is not supported). The URL must end in “.jpg” or “.png”. If the
|
||||
<itunes:image> tag is not present, iTunes will use the contents of the
|
||||
RSS image tag.</p>
|
||||
<p>If you change your podcast’s image, also change the file’s name. iTunes
|
||||
|
|
@ -191,7 +188,7 @@ requests for iTS to be able to automatically update your cover art.</p>
|
|||
<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"><strong>itunes_image</strong> – Image of the podcast.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_image</strong> – Image of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Image of the podcast.</td>
|
||||
</tr>
|
||||
|
|
@ -205,12 +202,12 @@ requests for iTS to be able to automatically update your cover art.</p>
|
|||
<dd><p>Get or set the is_closed_captioned value of the podcast episode.
|
||||
This tag should be used if your podcast includes a video episode with
|
||||
embedded closed captioning support. The two values for this tag are
|
||||
“yes” and “no”.</p>
|
||||
“yes” and “no”.</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"><strong>is_closed_captioned</strong> – If the episode has closed captioning
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>is_closed_captioned</strong> – If the episode has closed captioning
|
||||
support.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the episode has closed captioning support.</td>
|
||||
|
|
@ -236,7 +233,7 @@ zero.</p>
|
|||
<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"><strong>itunes_order</strong> – The order of the episode.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_order</strong> – The order of the episode.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The order of the episode.</td>
|
||||
</tr>
|
||||
|
|
@ -254,7 +251,7 @@ subtitle displays best if it is only a few words long.</p>
|
|||
<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"><strong>itunes_subtitle</strong> – Subtitle of the podcast episode.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_subtitle</strong> – Subtitle of the podcast episode.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Subtitle of the podcast episode.</td>
|
||||
</tr>
|
||||
|
|
@ -267,7 +264,7 @@ subtitle displays best if it is only a few words long.</p>
|
|||
<code class="descname">itunes_summary</code><span class="sig-paren">(</span><em>itunes_summary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:summary value for the podcast episode. The
|
||||
contents of this tag are shown in a separate window that appears when
|
||||
the “circled i” in the Description column is clicked. It also appears
|
||||
the “circled i” in the Description column is clicked. It also appears
|
||||
on the iTunes page for your podcast. This field can be up to 4000
|
||||
characters. If <itunes:summary> is not included, the contents of the
|
||||
<description> tag are used.</p>
|
||||
|
|
@ -275,7 +272,7 @@ characters. If <itunes:summary> is not included, the contents of the
|
|||
<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"><strong>itunes_summary</strong> – Summary of the podcast episode.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>itunes_summary</strong> – Summary of the podcast episode.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Summary of the podcast episode.</td>
|
||||
</tr>
|
||||
|
|
@ -303,7 +300,7 @@ characters. If <itunes:summary> is not included, the contents of the
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.torrent — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>feedgen.ext.torrent — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -28,9 +25,9 @@
|
|||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="prev" title="feedgen.ext.podcast_entry" href="api.ext.podcast_entry.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.torrent</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -63,7 +60,7 @@
|
|||
<dl class="class">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension">
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.torrent.</code><code class="descname">TorrentEntryExtension</code><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>FeedEntry extention for torrent feeds</p>
|
||||
<dd><p>FeedEntry extension for torrent feeds</p>
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension.contentlength">
|
||||
<code class="descname">contentlength</code><span class="sig-paren">(</span><em>torrent_contentlength=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.contentlength" title="Permalink to this definition">¶</a></dt>
|
||||
|
|
@ -72,7 +69,7 @@
|
|||
<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"><strong>torrent_contentlength</strong> – The target file size.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_contentlength</strong> – The target file size.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The target file size.</td>
|
||||
</tr>
|
||||
|
|
@ -88,7 +85,7 @@
|
|||
<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"><strong>feed</strong> – The RSS item XML element to use.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>feed</strong> – The RSS item XML element to use.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -102,7 +99,7 @@
|
|||
<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"><strong>torrent_filename</strong> – The name of the torrent file.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_filename</strong> – The name of the torrent file.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The name of the torrent file.</td>
|
||||
</tr>
|
||||
|
|
@ -118,7 +115,7 @@
|
|||
<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"><strong>torrent_infohash</strong> – The target file hash.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_infohash</strong> – The target file hash.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The target hash file.</td>
|
||||
</tr>
|
||||
|
|
@ -134,7 +131,7 @@
|
|||
<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"><strong>torrent_infohash</strong> – The peers number.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_infohash</strong> – The peers number.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The peers number.</td>
|
||||
</tr>
|
||||
|
|
@ -150,7 +147,7 @@
|
|||
<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"><strong>torrent_seeds</strong> – The seeds number.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_seeds</strong> – The seeds number.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The seeds number.</td>
|
||||
</tr>
|
||||
|
|
@ -166,7 +163,7 @@
|
|||
<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"><strong>torrent_infohash</strong> – The verified peers number.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>torrent_infohash</strong> – The verified peers number.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The verified peers number.</td>
|
||||
</tr>
|
||||
|
|
@ -198,7 +195,7 @@
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,21 +1,18 @@
|
|||
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>Index — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -28,9 +25,9 @@
|
|||
<link rel="index" title="Index" href="#" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Index</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -385,6 +382,8 @@
|
|||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="api.entry.html#feedgen.entry.FeedEntry.pubDate">pubDate() (feedgen.entry.FeedEntry method)</a>
|
||||
</li>
|
||||
<li><a href="api.entry.html#feedgen.entry.FeedEntry.pubdate">pubdate() (feedgen.entry.FeedEntry method)</a>
|
||||
</li>
|
||||
<li><a href="api.feed.html#feedgen.feed.FeedGenerator.pubDate">pubDate() (feedgen.feed.FeedGenerator method)</a>
|
||||
|
|
@ -511,7 +510,7 @@
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
25
index.html
25
index.html
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Feedgenerator — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>Feedgenerator — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -28,9 +25,9 @@
|
|||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="API Documentation" href="api.html" />
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="#">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Feedgenerator</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -148,7 +145,7 @@ FeedEntry object:</p>
|
|||
<span class="gp">>>> </span><span class="n">fe</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="n">href</span><span class="o">=</span><span class="s2">"http://lernfunk.de/feed"</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The FeedGenerators method <cite>add_entry(...)</cite> without argument provides will
|
||||
<p>The FeedGenerators method <cite>add_entry(…)</cite> without argument provides will
|
||||
automatically generate a new FeedEntry object, append it to the feeds internal
|
||||
list of entries and return it, so that additional data can be added.</p>
|
||||
</div>
|
||||
|
|
@ -161,10 +158,10 @@ structure of the feeds. Extensions can be loaded like this:</p>
|
|||
</div>
|
||||
<p>This will try to load the extension “someext” from the file <cite>ext/someext.py</cite>.
|
||||
It is required that <cite>someext.py</cite> contains a class named “SomextExtension” which
|
||||
is required to have at least the two methods <cite>extend_rss(...)</cite> and
|
||||
<cite>extend_atom(...)</cite>. Although not required, it is strongly suggested to use
|
||||
is required to have at least the two methods <cite>extend_rss(…)</cite> and
|
||||
<cite>extend_atom(…)</cite>. Although not required, it is strongly suggested to use
|
||||
<cite>BaseExtension</cite> from <cite>ext/base.py</cite> as superclass.</p>
|
||||
<p><cite>load_extension(‘someext’, ...)</cite> will also try to load a class named
|
||||
<p><cite>load_extension(‘someext’, …)</cite> will also try to load a class named
|
||||
“SomextEntryExtension” for every entry of the feed. This class can be located
|
||||
either in the same file as SomextExtension or in <cite>ext/someext_entry.py</cite> which
|
||||
is suggested especially for large extensions.</p>
|
||||
|
|
@ -194,7 +191,7 @@ feed with some additional elements for ITunes.</p>
|
|||
<p>Of cause the extension has to be loaded for the FeedEntry objects as well but
|
||||
this is done automatically by the FeedGenerator for every feed entry if the
|
||||
extension is loaded for the whole feed. You can, however, load an extension for
|
||||
a specific FeedEntry by calling <cite>load_extension(...)</cite> on that entry. But this
|
||||
a specific FeedEntry by calling <cite>load_extension(…)</cite> on that entry. But this
|
||||
is a rather uncommon use.</p>
|
||||
<p>You can still produce a normal ATOM or RSS feed, even if you have loaded some
|
||||
plugins by temporary disabling them during the feed generation. This can be
|
||||
|
|
@ -259,7 +256,7 @@ example for a whole feed generation process, you can find it in the
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Python Module Index — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>Python Module Index — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -30,9 +27,9 @@
|
|||
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Python Module Index</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -116,7 +113,7 @@
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
15
search.html
15
search.html
|
|
@ -1,20 +1,17 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — python-feedgen 0.6.1 documentation</title>
|
||||
|
||||
<title>Search — python-feedgen 0.7.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.6.1',
|
||||
VERSION: '0.7.0',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
|
|
@ -35,9 +32,9 @@
|
|||
|
||||
|
||||
</head>
|
||||
<body role="document">
|
||||
<body>
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.6.1 documentation</span></a></h1>
|
||||
<span>python-feedgen 0.7.0 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Search</span></h2>
|
||||
</div>
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
|
@ -85,7 +82,7 @@
|
|||
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue