python-flot-utils
Advanced tools
| .. Python Flot Utils documentation master file, created by | ||
| sphinx-quickstart on Thu Feb 17 16:27:52 2011. | ||
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. | ||
| Easily Generate Flot Graphs Using Python | ||
| ======================================== | ||
| PyFlot makes it easy to generate flot_ graphs. Its primary goal is to | ||
| allow one to specify data inputs and options in a Python application | ||
| and generate the appropriate JSON. Common uses of this will be rendering | ||
| into a template as flot() arguments or as the payload of an XHR response. | ||
| PyFlot takes care of all the annoying details of converting types to match | ||
| up with how `flot` expects them. | ||
| For example:: | ||
| >>> import pyflot | ||
| >>> graph = pyflot.Flot() | ||
| >>> graph.add_line([(1, 1), (2, 2), (3, 3)]) | ||
| >>> print graph.series_json | ||
| [{"data": [[1, 1], [2, 2], [3, 3]]}] | ||
| In this simple example the ``series_json`` is a JSON string | ||
| in the format expected by ``flot``. | ||
| The following Django template snippet shows how you might use | ||
| it in a Django template: | ||
| .. code-block:: HTML+Django/Jinja | ||
| <script id="source" language="javascript" type="text/javascript"> | ||
| $(function () { | ||
| $.plot($("#linear-graph"), {{ graph.series_json|safe }}, {{ graph.options_json|safe }}); | ||
| }); | ||
| </script> | ||
| .. _flot: http://code.google.com/p/flot/ | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| Indices and tables | ||
| ================== | ||
| * :ref:`genindex` | ||
| * :ref:`modindex` | ||
| * :ref:`search` | ||
| /* | ||
| * basic.css | ||
| * ~~~~~~~~~ | ||
| * | ||
| * Sphinx stylesheet -- basic theme. | ||
| * | ||
| * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. | ||
| * :license: BSD, see LICENSE for details. | ||
| * | ||
| */ | ||
| /* -- main layout ----------------------------------------------------------- */ | ||
| div.clearer { | ||
| clear: both; | ||
| } | ||
| /* -- relbar ---------------------------------------------------------------- */ | ||
| div.related { | ||
| width: 100%; | ||
| font-size: 90%; | ||
| } | ||
| div.related h3 { | ||
| display: none; | ||
| } | ||
| div.related ul { | ||
| margin: 0; | ||
| padding: 0 0 0 10px; | ||
| list-style: none; | ||
| } | ||
| div.related li { | ||
| display: inline; | ||
| } | ||
| div.related li.right { | ||
| float: right; | ||
| margin-right: 5px; | ||
| } | ||
| /* -- sidebar --------------------------------------------------------------- */ | ||
| div.sphinxsidebarwrapper { | ||
| padding: 10px 5px 0 10px; | ||
| } | ||
| div.sphinxsidebar { | ||
| float: left; | ||
| width: 230px; | ||
| margin-left: -100%; | ||
| font-size: 90%; | ||
| } | ||
| div.sphinxsidebar ul { | ||
| list-style: none; | ||
| } | ||
| div.sphinxsidebar ul ul, | ||
| div.sphinxsidebar ul.want-points { | ||
| margin-left: 20px; | ||
| list-style: square; | ||
| } | ||
| div.sphinxsidebar ul ul { | ||
| margin-top: 0; | ||
| margin-bottom: 0; | ||
| } | ||
| div.sphinxsidebar form { | ||
| margin-top: 10px; | ||
| } | ||
| div.sphinxsidebar input { | ||
| border: 1px solid #98dbcc; | ||
| font-family: sans-serif; | ||
| font-size: 1em; | ||
| } | ||
| img { | ||
| border: 0; | ||
| } | ||
| /* -- search page ----------------------------------------------------------- */ | ||
| ul.search { | ||
| margin: 10px 0 0 20px; | ||
| padding: 0; | ||
| } | ||
| ul.search li { | ||
| padding: 5px 0 5px 20px; | ||
| background-image: url(file.png); | ||
| background-repeat: no-repeat; | ||
| background-position: 0 7px; | ||
| } | ||
| ul.search li a { | ||
| font-weight: bold; | ||
| } | ||
| ul.search li div.context { | ||
| color: #888; | ||
| margin: 2px 0 0 30px; | ||
| text-align: left; | ||
| } | ||
| ul.keywordmatches li.goodmatch a { | ||
| font-weight: bold; | ||
| } | ||
| /* -- index page ------------------------------------------------------------ */ | ||
| table.contentstable { | ||
| width: 90%; | ||
| } | ||
| table.contentstable p.biglink { | ||
| line-height: 150%; | ||
| } | ||
| a.biglink { | ||
| font-size: 1.3em; | ||
| } | ||
| span.linkdescr { | ||
| font-style: italic; | ||
| padding-top: 5px; | ||
| font-size: 90%; | ||
| } | ||
| /* -- general index --------------------------------------------------------- */ | ||
| table.indextable { | ||
| width: 100%; | ||
| } | ||
| table.indextable td { | ||
| text-align: left; | ||
| vertical-align: top; | ||
| } | ||
| table.indextable dl, table.indextable dd { | ||
| margin-top: 0; | ||
| margin-bottom: 0; | ||
| } | ||
| table.indextable tr.pcap { | ||
| height: 10px; | ||
| } | ||
| table.indextable tr.cap { | ||
| margin-top: 10px; | ||
| background-color: #f2f2f2; | ||
| } | ||
| img.toggler { | ||
| margin-right: 3px; | ||
| margin-top: 3px; | ||
| cursor: pointer; | ||
| } | ||
| div.modindex-jumpbox { | ||
| border-top: 1px solid #ddd; | ||
| border-bottom: 1px solid #ddd; | ||
| margin: 1em 0 1em 0; | ||
| padding: 0.4em; | ||
| } | ||
| div.genindex-jumpbox { | ||
| border-top: 1px solid #ddd; | ||
| border-bottom: 1px solid #ddd; | ||
| margin: 1em 0 1em 0; | ||
| padding: 0.4em; | ||
| } | ||
| /* -- general body styles --------------------------------------------------- */ | ||
| a.headerlink { | ||
| visibility: hidden; | ||
| } | ||
| h1:hover > a.headerlink, | ||
| h2:hover > a.headerlink, | ||
| h3:hover > a.headerlink, | ||
| h4:hover > a.headerlink, | ||
| h5:hover > a.headerlink, | ||
| h6:hover > a.headerlink, | ||
| dt:hover > a.headerlink { | ||
| visibility: visible; | ||
| } | ||
| div.body p.caption { | ||
| text-align: inherit; | ||
| } | ||
| div.body td { | ||
| text-align: left; | ||
| } | ||
| .field-list ul { | ||
| padding-left: 1em; | ||
| } | ||
| .first { | ||
| margin-top: 0 !important; | ||
| } | ||
| p.rubric { | ||
| margin-top: 30px; | ||
| font-weight: bold; | ||
| } | ||
| img.align-left, .figure.align-left, object.align-left { | ||
| clear: left; | ||
| float: left; | ||
| margin-right: 1em; | ||
| } | ||
| img.align-right, .figure.align-right, object.align-right { | ||
| clear: right; | ||
| float: right; | ||
| margin-left: 1em; | ||
| } | ||
| img.align-center, .figure.align-center, object.align-center { | ||
| display: block; | ||
| margin-left: auto; | ||
| margin-right: auto; | ||
| } | ||
| .align-left { | ||
| text-align: left; | ||
| } | ||
| .align-center { | ||
| clear: both; | ||
| text-align: center; | ||
| } | ||
| .align-right { | ||
| text-align: right; | ||
| } | ||
| /* -- sidebars -------------------------------------------------------------- */ | ||
| div.sidebar { | ||
| margin: 0 0 0.5em 1em; | ||
| border: 1px solid #ddb; | ||
| padding: 7px 7px 0 7px; | ||
| background-color: #ffe; | ||
| width: 40%; | ||
| float: right; | ||
| } | ||
| p.sidebar-title { | ||
| font-weight: bold; | ||
| } | ||
| /* -- topics ---------------------------------------------------------------- */ | ||
| div.topic { | ||
| border: 1px solid #ccc; | ||
| padding: 7px 7px 0 7px; | ||
| margin: 10px 0 10px 0; | ||
| } | ||
| p.topic-title { | ||
| font-size: 1.1em; | ||
| font-weight: bold; | ||
| margin-top: 10px; | ||
| } | ||
| /* -- admonitions ----------------------------------------------------------- */ | ||
| div.admonition { | ||
| margin-top: 10px; | ||
| margin-bottom: 10px; | ||
| padding: 7px; | ||
| } | ||
| div.admonition dt { | ||
| font-weight: bold; | ||
| } | ||
| div.admonition dl { | ||
| margin-bottom: 0; | ||
| } | ||
| p.admonition-title { | ||
| margin: 0px 10px 5px 0px; | ||
| font-weight: bold; | ||
| } | ||
| div.body p.centered { | ||
| text-align: center; | ||
| margin-top: 25px; | ||
| } | ||
| /* -- tables ---------------------------------------------------------------- */ | ||
| table.docutils { | ||
| border: 0; | ||
| border-collapse: collapse; | ||
| } | ||
| table.docutils td, table.docutils th { | ||
| padding: 1px 8px 1px 5px; | ||
| border-top: 0; | ||
| border-left: 0; | ||
| border-right: 0; | ||
| border-bottom: 1px solid #aaa; | ||
| } | ||
| table.field-list td, table.field-list th { | ||
| border: 0 !important; | ||
| } | ||
| table.footnote td, table.footnote th { | ||
| border: 0 !important; | ||
| } | ||
| th { | ||
| text-align: left; | ||
| padding-right: 5px; | ||
| } | ||
| table.citation { | ||
| border-left: solid 1px gray; | ||
| margin-left: 1px; | ||
| } | ||
| table.citation td { | ||
| border-bottom: none; | ||
| } | ||
| /* -- other body styles ----------------------------------------------------- */ | ||
| ol.arabic { | ||
| list-style: decimal; | ||
| } | ||
| ol.loweralpha { | ||
| list-style: lower-alpha; | ||
| } | ||
| ol.upperalpha { | ||
| list-style: upper-alpha; | ||
| } | ||
| ol.lowerroman { | ||
| list-style: lower-roman; | ||
| } | ||
| ol.upperroman { | ||
| list-style: upper-roman; | ||
| } | ||
| dl { | ||
| margin-bottom: 15px; | ||
| } | ||
| dd p { | ||
| margin-top: 0px; | ||
| } | ||
| dd ul, dd table { | ||
| margin-bottom: 10px; | ||
| } | ||
| dd { | ||
| margin-top: 3px; | ||
| margin-bottom: 10px; | ||
| margin-left: 30px; | ||
| } | ||
| dt:target, .highlighted { | ||
| background-color: #fbe54e; | ||
| } | ||
| dl.glossary dt { | ||
| font-weight: bold; | ||
| font-size: 1.1em; | ||
| } | ||
| .field-list ul { | ||
| margin: 0; | ||
| padding-left: 1em; | ||
| } | ||
| .field-list p { | ||
| margin: 0; | ||
| } | ||
| .refcount { | ||
| color: #060; | ||
| } | ||
| .optional { | ||
| font-size: 1.3em; | ||
| } | ||
| .versionmodified { | ||
| font-style: italic; | ||
| } | ||
| .system-message { | ||
| background-color: #fda; | ||
| padding: 5px; | ||
| border: 3px solid red; | ||
| } | ||
| .footnote:target { | ||
| background-color: #ffa; | ||
| } | ||
| .line-block { | ||
| display: block; | ||
| margin-top: 1em; | ||
| margin-bottom: 1em; | ||
| } | ||
| .line-block .line-block { | ||
| margin-top: 0; | ||
| margin-bottom: 0; | ||
| margin-left: 1.5em; | ||
| } | ||
| .guilabel, .menuselection { | ||
| font-family: sans-serif; | ||
| } | ||
| .accelerator { | ||
| text-decoration: underline; | ||
| } | ||
| .classifier { | ||
| font-style: oblique; | ||
| } | ||
| /* -- code displays --------------------------------------------------------- */ | ||
| pre { | ||
| overflow: auto; | ||
| overflow-y: hidden; /* fixes display issues on Chrome browsers */ | ||
| } | ||
| td.linenos pre { | ||
| padding: 5px 0px; | ||
| border: 0; | ||
| background-color: transparent; | ||
| color: #aaa; | ||
| } | ||
| table.highlighttable { | ||
| margin-left: 0.5em; | ||
| } | ||
| table.highlighttable td { | ||
| padding: 0 0.5em 0 0.5em; | ||
| } | ||
| tt.descname { | ||
| background-color: transparent; | ||
| font-weight: bold; | ||
| font-size: 1.2em; | ||
| } | ||
| tt.descclassname { | ||
| background-color: transparent; | ||
| } | ||
| tt.xref, a tt { | ||
| background-color: transparent; | ||
| font-weight: bold; | ||
| } | ||
| h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { | ||
| background-color: transparent; | ||
| } | ||
| .viewcode-link { | ||
| float: right; | ||
| } | ||
| .viewcode-back { | ||
| float: right; | ||
| font-family: sans-serif; | ||
| } | ||
| div.viewcode-block:target { | ||
| margin: -1px -10px; | ||
| padding: 0 10px; | ||
| } | ||
| /* -- math display ---------------------------------------------------------- */ | ||
| img.math { | ||
| vertical-align: middle; | ||
| } | ||
| div.body div.math p { | ||
| text-align: center; | ||
| } | ||
| span.eqno { | ||
| float: right; | ||
| } | ||
| /* -- printout stylesheet --------------------------------------------------- */ | ||
| @media print { | ||
| div.document, | ||
| div.documentwrapper, | ||
| div.bodywrapper { | ||
| margin: 0 !important; | ||
| width: 100%; | ||
| } | ||
| div.sphinxsidebar, | ||
| div.related, | ||
| div.footer, | ||
| #top-link { | ||
| display: none; | ||
| } | ||
| } |
| /* | ||
| * default.css_t | ||
| * ~~~~~~~~~~~~~ | ||
| * | ||
| * Sphinx stylesheet -- default theme. | ||
| * | ||
| * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. | ||
| * :license: BSD, see LICENSE for details. | ||
| * | ||
| */ | ||
| @import url("basic.css"); | ||
| /* -- page layout ----------------------------------------------------------- */ | ||
| body { | ||
| font-family: sans-serif; | ||
| font-size: 100%; | ||
| background-color: #11303d; | ||
| color: #000; | ||
| margin: 0; | ||
| padding: 0; | ||
| } | ||
| div.document { | ||
| background-color: #1c4e63; | ||
| } | ||
| div.documentwrapper { | ||
| float: left; | ||
| width: 100%; | ||
| } | ||
| div.bodywrapper { | ||
| margin: 0 0 0 230px; | ||
| } | ||
| div.body { | ||
| background-color: #ffffff; | ||
| color: #000000; | ||
| padding: 0 20px 30px 20px; | ||
| } | ||
| div.footer { | ||
| color: #ffffff; | ||
| width: 100%; | ||
| padding: 9px 0 9px 0; | ||
| text-align: center; | ||
| font-size: 75%; | ||
| } | ||
| div.footer a { | ||
| color: #ffffff; | ||
| text-decoration: underline; | ||
| } | ||
| div.related { | ||
| background-color: #133f52; | ||
| line-height: 30px; | ||
| color: #ffffff; | ||
| } | ||
| div.related a { | ||
| color: #ffffff; | ||
| } | ||
| div.sphinxsidebar { | ||
| } | ||
| div.sphinxsidebar h3 { | ||
| font-family: 'Trebuchet MS', sans-serif; | ||
| color: #ffffff; | ||
| font-size: 1.4em; | ||
| font-weight: normal; | ||
| margin: 0; | ||
| padding: 0; | ||
| } | ||
| div.sphinxsidebar h3 a { | ||
| color: #ffffff; | ||
| } | ||
| div.sphinxsidebar h4 { | ||
| font-family: 'Trebuchet MS', sans-serif; | ||
| color: #ffffff; | ||
| font-size: 1.3em; | ||
| font-weight: normal; | ||
| margin: 5px 0 0 0; | ||
| padding: 0; | ||
| } | ||
| div.sphinxsidebar p { | ||
| color: #ffffff; | ||
| } | ||
| div.sphinxsidebar p.topless { | ||
| margin: 5px 10px 10px 10px; | ||
| } | ||
| div.sphinxsidebar ul { | ||
| margin: 10px; | ||
| padding: 0; | ||
| color: #ffffff; | ||
| } | ||
| div.sphinxsidebar a { | ||
| color: #98dbcc; | ||
| } | ||
| div.sphinxsidebar input { | ||
| border: 1px solid #98dbcc; | ||
| font-family: sans-serif; | ||
| font-size: 1em; | ||
| } | ||
| /* -- hyperlink styles ------------------------------------------------------ */ | ||
| a { | ||
| color: #355f7c; | ||
| text-decoration: none; | ||
| } | ||
| a:visited { | ||
| color: #355f7c; | ||
| text-decoration: none; | ||
| } | ||
| a:hover { | ||
| text-decoration: underline; | ||
| } | ||
| /* -- body styles ----------------------------------------------------------- */ | ||
| div.body h1, | ||
| div.body h2, | ||
| div.body h3, | ||
| div.body h4, | ||
| div.body h5, | ||
| div.body h6 { | ||
| font-family: 'Trebuchet MS', sans-serif; | ||
| background-color: #f2f2f2; | ||
| font-weight: normal; | ||
| color: #20435c; | ||
| border-bottom: 1px solid #ccc; | ||
| margin: 20px -20px 10px -20px; | ||
| padding: 3px 0 3px 10px; | ||
| } | ||
| div.body h1 { margin-top: 0; font-size: 200%; } | ||
| div.body h2 { font-size: 160%; } | ||
| div.body h3 { font-size: 140%; } | ||
| div.body h4 { font-size: 120%; } | ||
| div.body h5 { font-size: 110%; } | ||
| div.body h6 { font-size: 100%; } | ||
| a.headerlink { | ||
| color: #c60f0f; | ||
| font-size: 0.8em; | ||
| padding: 0 4px 0 4px; | ||
| text-decoration: none; | ||
| } | ||
| a.headerlink:hover { | ||
| background-color: #c60f0f; | ||
| color: white; | ||
| } | ||
| div.body p, div.body dd, div.body li { | ||
| text-align: justify; | ||
| line-height: 130%; | ||
| } | ||
| div.admonition p.admonition-title + p { | ||
| display: inline; | ||
| } | ||
| div.admonition p { | ||
| margin-bottom: 5px; | ||
| } | ||
| div.admonition pre { | ||
| margin-bottom: 5px; | ||
| } | ||
| div.admonition ul, div.admonition ol { | ||
| margin-bottom: 5px; | ||
| } | ||
| div.note { | ||
| background-color: #eee; | ||
| border: 1px solid #ccc; | ||
| } | ||
| div.seealso { | ||
| background-color: #ffc; | ||
| border: 1px solid #ff6; | ||
| } | ||
| div.topic { | ||
| background-color: #eee; | ||
| } | ||
| div.warning { | ||
| background-color: #ffe4e4; | ||
| border: 1px solid #f66; | ||
| } | ||
| p.admonition-title { | ||
| display: inline; | ||
| } | ||
| p.admonition-title:after { | ||
| content: ":"; | ||
| } | ||
| pre { | ||
| padding: 5px; | ||
| background-color: #eeffcc; | ||
| color: #333333; | ||
| line-height: 120%; | ||
| border: 1px solid #ac9; | ||
| border-left: none; | ||
| border-right: none; | ||
| } | ||
| tt { | ||
| background-color: #ecf0f3; | ||
| padding: 0 1px 0 1px; | ||
| font-size: 0.95em; | ||
| } | ||
| th { | ||
| background-color: #ede; | ||
| } | ||
| .warning tt { | ||
| background: #efc2c2; | ||
| } | ||
| .note tt { | ||
| background: #d6d6d6; | ||
| } | ||
| .viewcode-back { | ||
| font-family: sans-serif; | ||
| } | ||
| div.viewcode-block:target { | ||
| background-color: #f4debf; | ||
| border-top: 1px solid #ac9; | ||
| border-bottom: 1px solid #ac9; | ||
| } |
| /* | ||
| * doctools.js | ||
| * ~~~~~~~~~~~ | ||
| * | ||
| * Sphinx JavaScript utilties for all documentation. | ||
| * | ||
| * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. | ||
| * :license: BSD, see LICENSE for details. | ||
| * | ||
| */ | ||
| /** | ||
| * select a different prefix for underscore | ||
| */ | ||
| $u = _.noConflict(); | ||
| /** | ||
| * make the code below compatible with browsers without | ||
| * an installed firebug like debugger | ||
| if (!window.console || !console.firebug) { | ||
| var names = ["log", "debug", "info", "warn", "error", "assert", "dir", | ||
| "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", | ||
| "profile", "profileEnd"]; | ||
| window.console = {}; | ||
| for (var i = 0; i < names.length; ++i) | ||
| window.console[names[i]] = function() {}; | ||
| } | ||
| */ | ||
| /** | ||
| * small helper function to urldecode strings | ||
| */ | ||
| jQuery.urldecode = function(x) { | ||
| return decodeURIComponent(x).replace(/\+/g, ' '); | ||
| } | ||
| /** | ||
| * small helper function to urlencode strings | ||
| */ | ||
| jQuery.urlencode = encodeURIComponent; | ||
| /** | ||
| * This function returns the parsed url parameters of the | ||
| * current request. Multiple values per key are supported, | ||
| * it will always return arrays of strings for the value parts. | ||
| */ | ||
| jQuery.getQueryParameters = function(s) { | ||
| if (typeof s == 'undefined') | ||
| s = document.location.search; | ||
| var parts = s.substr(s.indexOf('?') + 1).split('&'); | ||
| var result = {}; | ||
| for (var i = 0; i < parts.length; i++) { | ||
| var tmp = parts[i].split('=', 2); | ||
| var key = jQuery.urldecode(tmp[0]); | ||
| var value = jQuery.urldecode(tmp[1]); | ||
| if (key in result) | ||
| result[key].push(value); | ||
| else | ||
| result[key] = [value]; | ||
| } | ||
| return result; | ||
| }; | ||
| /** | ||
| * small function to check if an array contains | ||
| * a given item. | ||
| */ | ||
| jQuery.contains = function(arr, item) { | ||
| for (var i = 0; i < arr.length; i++) { | ||
| if (arr[i] == item) | ||
| return true; | ||
| } | ||
| return false; | ||
| }; | ||
| /** | ||
| * highlight a given string on a jquery object by wrapping it in | ||
| * span elements with the given class name. | ||
| */ | ||
| jQuery.fn.highlightText = function(text, className) { | ||
| function highlight(node) { | ||
| 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"); | ||
| 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); | ||
| } | ||
| } | ||
| else if (!jQuery(node).is("button, select, textarea")) { | ||
| jQuery.each(node.childNodes, function() { | ||
| highlight(this); | ||
| }); | ||
| } | ||
| } | ||
| return this.each(function() { | ||
| highlight(this); | ||
| }); | ||
| }; | ||
| /** | ||
| * Small JavaScript module for the documentation. | ||
| */ | ||
| var Documentation = { | ||
| init : function() { | ||
| this.fixFirefoxAnchorBug(); | ||
| this.highlightSearchWords(); | ||
| this.initIndexTable(); | ||
| }, | ||
| /** | ||
| * i18n support | ||
| */ | ||
| TRANSLATIONS : {}, | ||
| 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') | ||
| return string; | ||
| return (typeof translated == 'string') ? translated : translated[0]; | ||
| }, | ||
| ngettext : function(singular, plural, n) { | ||
| var translated = Documentation.TRANSLATIONS[singular]; | ||
| if (typeof translated == 'undefined') | ||
| return (n == 1) ? singular : plural; | ||
| return translated[Documentation.PLURALEXPR(n)]; | ||
| }, | ||
| addTranslations : function(catalog) { | ||
| for (var key in catalog.messages) | ||
| this.TRANSLATIONS[key] = catalog.messages[key]; | ||
| this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); | ||
| this.LOCALE = catalog.locale; | ||
| }, | ||
| /** | ||
| * add context elements like header anchor links | ||
| */ | ||
| addContextElements : function() { | ||
| $('div[id] > :header:first').each(function() { | ||
| $('<a class="headerlink">\u00B6</a>'). | ||
| attr('href', '#' + this.id). | ||
| attr('title', _('Permalink to this headline')). | ||
| appendTo(this); | ||
| }); | ||
| $('dt[id]').each(function() { | ||
| $('<a class="headerlink">\u00B6</a>'). | ||
| attr('href', '#' + this.id). | ||
| attr('title', _('Permalink to this definition')). | ||
| appendTo(this); | ||
| }); | ||
| }, | ||
| /** | ||
| * workaround a firefox stupidity | ||
| */ | ||
| fixFirefoxAnchorBug : function() { | ||
| if (document.location.hash && $.browser.mozilla) | ||
| window.setTimeout(function() { | ||
| document.location.href += ''; | ||
| }, 10); | ||
| }, | ||
| /** | ||
| * highlight the search words provided in the url in the text | ||
| */ | ||
| highlightSearchWords : function() { | ||
| var params = $.getQueryParameters(); | ||
| var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; | ||
| if (terms.length) { | ||
| var body = $('div.body'); | ||
| window.setTimeout(function() { | ||
| $.each(terms, function() { | ||
| body.highlightText(this.toLowerCase(), 'highlighted'); | ||
| }); | ||
| }, 10); | ||
| $('<li class="highlight-link"><a href="javascript:Documentation.' + | ||
| 'hideSearchWords()">' + _('Hide Search Matches') + '</a></li>') | ||
| .appendTo($('.sidebar .this-page-menu')); | ||
| } | ||
| }, | ||
| /** | ||
| * init the domain index toggle buttons | ||
| */ | ||
| initIndexTable : function() { | ||
| var togglers = $('img.toggler').click(function() { | ||
| var src = $(this).attr('src'); | ||
| var idnum = $(this).attr('id').substr(7); | ||
| $('tr.cg-' + idnum).toggle(); | ||
| 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'); | ||
| }).css('display', ''); | ||
| if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { | ||
| togglers.click(); | ||
| } | ||
| }, | ||
| /** | ||
| * helper function to hide the search marks again | ||
| */ | ||
| hideSearchWords : function() { | ||
| $('.sidebar .this-page-menu li.highlight-link').fadeOut(300); | ||
| $('span.highlighted').removeClass('highlighted'); | ||
| }, | ||
| /** | ||
| * make the url absolute | ||
| */ | ||
| makeURL : function(relativeURL) { | ||
| return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; | ||
| }, | ||
| /** | ||
| * get the current relative url | ||
| */ | ||
| getCurrentURL : function() { | ||
| var path = document.location.pathname; | ||
| var parts = path.split(/\//); | ||
| $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { | ||
| if (this == '..') | ||
| parts.pop(); | ||
| }); | ||
| var url = parts.join('/'); | ||
| return path.substring(url.lastIndexOf('/') + 1, path.length - 1); | ||
| } | ||
| }; | ||
| // quick alias for translations | ||
| _ = Documentation.gettext; | ||
| $(document).ready(function() { | ||
| Documentation.init(); | ||
| }); |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
| .highlight .hll { background-color: #ffffcc } | ||
| .highlight { background: #eeffcc; } | ||
| .highlight .c { color: #408090; font-style: italic } /* Comment */ | ||
| .highlight .err { border: 1px solid #FF0000 } /* Error */ | ||
| .highlight .k { color: #007020; font-weight: bold } /* Keyword */ | ||
| .highlight .o { color: #666666 } /* Operator */ | ||
| .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ | ||
| .highlight .cp { color: #007020 } /* Comment.Preproc */ | ||
| .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ | ||
| .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ | ||
| .highlight .gd { color: #A00000 } /* Generic.Deleted */ | ||
| .highlight .ge { font-style: italic } /* Generic.Emph */ | ||
| .highlight .gr { color: #FF0000 } /* Generic.Error */ | ||
| .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ | ||
| .highlight .gi { color: #00A000 } /* Generic.Inserted */ | ||
| .highlight .go { color: #303030 } /* Generic.Output */ | ||
| .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ | ||
| .highlight .gs { font-weight: bold } /* Generic.Strong */ | ||
| .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ | ||
| .highlight .gt { color: #0040D0 } /* Generic.Traceback */ | ||
| .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ | ||
| .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ | ||
| .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ | ||
| .highlight .kp { color: #007020 } /* Keyword.Pseudo */ | ||
| .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ | ||
| .highlight .kt { color: #902000 } /* Keyword.Type */ | ||
| .highlight .m { color: #208050 } /* Literal.Number */ | ||
| .highlight .s { color: #4070a0 } /* Literal.String */ | ||
| .highlight .na { color: #4070a0 } /* Name.Attribute */ | ||
| .highlight .nb { color: #007020 } /* Name.Builtin */ | ||
| .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ | ||
| .highlight .no { color: #60add5 } /* Name.Constant */ | ||
| .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ | ||
| .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ | ||
| .highlight .ne { color: #007020 } /* Name.Exception */ | ||
| .highlight .nf { color: #06287e } /* Name.Function */ | ||
| .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ | ||
| .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ | ||
| .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ | ||
| .highlight .nv { color: #bb60d5 } /* Name.Variable */ | ||
| .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ | ||
| .highlight .w { color: #bbbbbb } /* Text.Whitespace */ | ||
| .highlight .mf { color: #208050 } /* Literal.Number.Float */ | ||
| .highlight .mh { color: #208050 } /* Literal.Number.Hex */ | ||
| .highlight .mi { color: #208050 } /* Literal.Number.Integer */ | ||
| .highlight .mo { color: #208050 } /* Literal.Number.Oct */ | ||
| .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ | ||
| .highlight .sc { color: #4070a0 } /* Literal.String.Char */ | ||
| .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ | ||
| .highlight .s2 { color: #4070a0 } /* Literal.String.Double */ | ||
| .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ | ||
| .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ | ||
| .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ | ||
| .highlight .sx { color: #c65d09 } /* Literal.String.Other */ | ||
| .highlight .sr { color: #235388 } /* Literal.String.Regex */ | ||
| .highlight .s1 { color: #4070a0 } /* Literal.String.Single */ | ||
| .highlight .ss { color: #517918 } /* Literal.String.Symbol */ | ||
| .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ | ||
| .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ | ||
| .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ | ||
| .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ | ||
| .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ |
| /* | ||
| * searchtools.js | ||
| * ~~~~~~~~~~~~~~ | ||
| * | ||
| * Sphinx JavaScript utilties for the full-text search. | ||
| * | ||
| * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. | ||
| * :license: BSD, see LICENSE for details. | ||
| * | ||
| */ | ||
| /** | ||
| * helper function to return a node containing the | ||
| * search summary for a given text. keywords is a list | ||
| * of stemmed words, hlwords is the list of normal, unstemmed | ||
| * words. the first one is used to find the occurance, the | ||
| * latter for highlighting it. | ||
| */ | ||
| jQuery.makeSearchSummary = function(text, keywords, hlwords) { | ||
| var textLower = text.toLowerCase(); | ||
| var start = 0; | ||
| $.each(keywords, function() { | ||
| var i = textLower.indexOf(this.toLowerCase()); | ||
| if (i > -1) | ||
| start = i; | ||
| }); | ||
| start = Math.max(start - 120, 0); | ||
| var excerpt = ((start > 0) ? '...' : '') + | ||
| $.trim(text.substr(start, 240)) + | ||
| ((start + 240 - text.length) ? '...' : ''); | ||
| var rv = $('<div class="context"></div>').text(excerpt); | ||
| $.each(hlwords, function() { | ||
| rv = rv.highlightText(this, 'highlighted'); | ||
| }); | ||
| return rv; | ||
| } | ||
| /** | ||
| * Porter Stemmer | ||
| */ | ||
| var PorterStemmer = function() { | ||
| var step2list = { | ||
| ational: 'ate', | ||
| tional: 'tion', | ||
| enci: 'ence', | ||
| anci: 'ance', | ||
| izer: 'ize', | ||
| bli: 'ble', | ||
| alli: 'al', | ||
| entli: 'ent', | ||
| eli: 'e', | ||
| ousli: 'ous', | ||
| ization: 'ize', | ||
| ation: 'ate', | ||
| ator: 'ate', | ||
| alism: 'al', | ||
| iveness: 'ive', | ||
| fulness: 'ful', | ||
| ousness: 'ous', | ||
| aliti: 'al', | ||
| iviti: 'ive', | ||
| biliti: 'ble', | ||
| logi: 'log' | ||
| }; | ||
| var step3list = { | ||
| icate: 'ic', | ||
| ative: '', | ||
| alize: 'al', | ||
| iciti: 'ic', | ||
| ical: 'ic', | ||
| ful: '', | ||
| ness: '' | ||
| }; | ||
| var c = "[^aeiou]"; // consonant | ||
| var v = "[aeiouy]"; // vowel | ||
| var C = c + "[^aeiouy]*"; // consonant sequence | ||
| var V = v + "[aeiou]*"; // vowel sequence | ||
| var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 | ||
| var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 | ||
| var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 | ||
| var s_v = "^(" + C + ")?" + v; // vowel in stem | ||
| this.stemWord = function (w) { | ||
| var stem; | ||
| var suffix; | ||
| var firstch; | ||
| var origword = w; | ||
| if (w.length < 3) | ||
| return w; | ||
| var re; | ||
| var re2; | ||
| var re3; | ||
| var re4; | ||
| firstch = w.substr(0,1); | ||
| if (firstch == "y") | ||
| w = firstch.toUpperCase() + w.substr(1); | ||
| // Step 1a | ||
| re = /^(.+?)(ss|i)es$/; | ||
| re2 = /^(.+?)([^s])s$/; | ||
| if (re.test(w)) | ||
| w = w.replace(re,"$1$2"); | ||
| else if (re2.test(w)) | ||
| w = w.replace(re2,"$1$2"); | ||
| // Step 1b | ||
| re = /^(.+?)eed$/; | ||
| re2 = /^(.+?)(ed|ing)$/; | ||
| if (re.test(w)) { | ||
| var fp = re.exec(w); | ||
| re = new RegExp(mgr0); | ||
| if (re.test(fp[1])) { | ||
| re = /.$/; | ||
| w = w.replace(re,""); | ||
| } | ||
| } | ||
| else if (re2.test(w)) { | ||
| var fp = re2.exec(w); | ||
| stem = fp[1]; | ||
| re2 = new RegExp(s_v); | ||
| if (re2.test(stem)) { | ||
| w = stem; | ||
| re2 = /(at|bl|iz)$/; | ||
| re3 = new RegExp("([^aeiouylsz])\\1$"); | ||
| re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); | ||
| if (re2.test(w)) | ||
| w = w + "e"; | ||
| else if (re3.test(w)) { | ||
| re = /.$/; | ||
| w = w.replace(re,""); | ||
| } | ||
| else if (re4.test(w)) | ||
| w = w + "e"; | ||
| } | ||
| } | ||
| // Step 1c | ||
| re = /^(.+?)y$/; | ||
| if (re.test(w)) { | ||
| var fp = re.exec(w); | ||
| stem = fp[1]; | ||
| re = new RegExp(s_v); | ||
| if (re.test(stem)) | ||
| w = stem + "i"; | ||
| } | ||
| // Step 2 | ||
| re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; | ||
| if (re.test(w)) { | ||
| var fp = re.exec(w); | ||
| stem = fp[1]; | ||
| suffix = fp[2]; | ||
| re = new RegExp(mgr0); | ||
| if (re.test(stem)) | ||
| w = stem + step2list[suffix]; | ||
| } | ||
| // Step 3 | ||
| re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; | ||
| if (re.test(w)) { | ||
| var fp = re.exec(w); | ||
| stem = fp[1]; | ||
| suffix = fp[2]; | ||
| re = new RegExp(mgr0); | ||
| if (re.test(stem)) | ||
| w = stem + step3list[suffix]; | ||
| } | ||
| // Step 4 | ||
| re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; | ||
| re2 = /^(.+?)(s|t)(ion)$/; | ||
| if (re.test(w)) { | ||
| var fp = re.exec(w); | ||
| stem = fp[1]; | ||
| re = new RegExp(mgr1); | ||
| if (re.test(stem)) | ||
| w = stem; | ||
| } | ||
| else if (re2.test(w)) { | ||
| var fp = re2.exec(w); | ||
| stem = fp[1] + fp[2]; | ||
| re2 = new RegExp(mgr1); | ||
| if (re2.test(stem)) | ||
| w = stem; | ||
| } | ||
| // Step 5 | ||
| re = /^(.+?)e$/; | ||
| if (re.test(w)) { | ||
| var fp = re.exec(w); | ||
| stem = fp[1]; | ||
| re = new RegExp(mgr1); | ||
| re2 = new RegExp(meq1); | ||
| re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); | ||
| if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) | ||
| w = stem; | ||
| } | ||
| re = /ll$/; | ||
| re2 = new RegExp(mgr1); | ||
| if (re.test(w) && re2.test(w)) { | ||
| re = /.$/; | ||
| w = w.replace(re,""); | ||
| } | ||
| // and turn initial Y back to y | ||
| if (firstch == "y") | ||
| w = firstch.toLowerCase() + w.substr(1); | ||
| return w; | ||
| } | ||
| } | ||
| /** | ||
| * Search Module | ||
| */ | ||
| var Search = { | ||
| _index : null, | ||
| _queued_query : null, | ||
| _pulse_status : -1, | ||
| init : function() { | ||
| var params = $.getQueryParameters(); | ||
| if (params.q) { | ||
| var query = params.q[0]; | ||
| $('input[name="q"]')[0].value = query; | ||
| this.performSearch(query); | ||
| } | ||
| }, | ||
| loadIndex : function(url) { | ||
| $.ajax({type: "GET", url: url, data: null, success: null, | ||
| dataType: "script", cache: true}); | ||
| }, | ||
| setIndex : function(index) { | ||
| var q; | ||
| this._index = index; | ||
| if ((q = this._queued_query) !== null) { | ||
| this._queued_query = null; | ||
| Search.query(q); | ||
| } | ||
| }, | ||
| hasIndex : function() { | ||
| return this._index !== null; | ||
| }, | ||
| deferQuery : function(query) { | ||
| this._queued_query = query; | ||
| }, | ||
| stopPulse : function() { | ||
| this._pulse_status = 0; | ||
| }, | ||
| startPulse : function() { | ||
| if (this._pulse_status >= 0) | ||
| return; | ||
| function pulse() { | ||
| Search._pulse_status = (Search._pulse_status + 1) % 4; | ||
| var dotString = ''; | ||
| for (var i = 0; i < Search._pulse_status; i++) | ||
| dotString += '.'; | ||
| Search.dots.text(dotString); | ||
| if (Search._pulse_status > -1) | ||
| window.setTimeout(pulse, 500); | ||
| }; | ||
| pulse(); | ||
| }, | ||
| /** | ||
| * perform a search for something | ||
| */ | ||
| performSearch : function(query) { | ||
| // create the required interface elements | ||
| this.out = $('#search-results'); | ||
| this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out); | ||
| this.dots = $('<span></span>').appendTo(this.title); | ||
| this.status = $('<p style="display: none"></p>').appendTo(this.out); | ||
| this.output = $('<ul class="search"/>').appendTo(this.out); | ||
| $('#search-progress').text(_('Preparing search...')); | ||
| this.startPulse(); | ||
| // index already loaded, the browser was quick! | ||
| if (this.hasIndex()) | ||
| this.query(query); | ||
| else | ||
| this.deferQuery(query); | ||
| }, | ||
| query : function(query) { | ||
| var stopwords = ['and', 'then', 'into', 'it', 'as', 'are', 'in', | ||
| 'if', 'for', 'no', 'there', 'their', 'was', 'is', | ||
| 'be', 'to', 'that', 'but', 'they', 'not', 'such', | ||
| 'with', 'by', 'a', 'on', 'these', 'of', 'will', | ||
| 'this', 'near', 'the', 'or', 'at']; | ||
| // stem the searchterms and add them to the correct list | ||
| var stemmer = new PorterStemmer(); | ||
| var searchterms = []; | ||
| var excluded = []; | ||
| var hlterms = []; | ||
| var tmp = query.split(/\s+/); | ||
| var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null; | ||
| for (var i = 0; i < tmp.length; i++) { | ||
| if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || | ||
| tmp[i] == "") { | ||
| // skip this "word" | ||
| continue; | ||
| } | ||
| // stem the word | ||
| var word = stemmer.stemWord(tmp[i]).toLowerCase(); | ||
| // select the correct list | ||
| if (word[0] == '-') { | ||
| var toAppend = excluded; | ||
| word = word.substr(1); | ||
| } | ||
| else { | ||
| var toAppend = searchterms; | ||
| hlterms.push(tmp[i].toLowerCase()); | ||
| } | ||
| // only add if not already in the list | ||
| if (!$.contains(toAppend, word)) | ||
| toAppend.push(word); | ||
| }; | ||
| var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); | ||
| // console.debug('SEARCH: searching for:'); | ||
| // console.info('required: ', searchterms); | ||
| // console.info('excluded: ', excluded); | ||
| // prepare search | ||
| var filenames = this._index.filenames; | ||
| var titles = this._index.titles; | ||
| var terms = this._index.terms; | ||
| var objects = this._index.objects; | ||
| var objtypes = this._index.objtypes; | ||
| var objnames = this._index.objnames; | ||
| var fileMap = {}; | ||
| var files = null; | ||
| // different result priorities | ||
| var importantResults = []; | ||
| var objectResults = []; | ||
| var regularResults = []; | ||
| var unimportantResults = []; | ||
| $('#search-progress').empty(); | ||
| // lookup as object | ||
| if (object != null) { | ||
| for (var prefix in objects) { | ||
| for (var name in objects[prefix]) { | ||
| var fullname = (prefix ? prefix + '.' : '') + name; | ||
| if (fullname.toLowerCase().indexOf(object) > -1) { | ||
| match = objects[prefix][name]; | ||
| descr = objnames[match[1]] + _(', in ') + titles[match[0]]; | ||
| // XXX the generated anchors are not generally correct | ||
| // XXX there may be custom prefixes | ||
| result = [filenames[match[0]], fullname, '#'+fullname, descr]; | ||
| switch (match[2]) { | ||
| case 1: objectResults.push(result); break; | ||
| case 0: importantResults.push(result); break; | ||
| case 2: unimportantResults.push(result); break; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| // sort results descending | ||
| objectResults.sort(function(a, b) { | ||
| return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); | ||
| }); | ||
| importantResults.sort(function(a, b) { | ||
| return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); | ||
| }); | ||
| unimportantResults.sort(function(a, b) { | ||
| return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); | ||
| }); | ||
| // perform the search on the required terms | ||
| for (var i = 0; i < searchterms.length; i++) { | ||
| var word = searchterms[i]; | ||
| // no match but word was a required one | ||
| if ((files = terms[word]) == null) | ||
| break; | ||
| if (files.length == undefined) { | ||
| files = [files]; | ||
| } | ||
| // create the mapping | ||
| for (var j = 0; j < files.length; j++) { | ||
| var file = files[j]; | ||
| if (file in fileMap) | ||
| fileMap[file].push(word); | ||
| else | ||
| fileMap[file] = [word]; | ||
| } | ||
| } | ||
| // now check if the files don't contain excluded terms | ||
| for (var file in fileMap) { | ||
| var valid = true; | ||
| // check if all requirements are matched | ||
| if (fileMap[file].length != searchterms.length) | ||
| continue; | ||
| // ensure that none of the excluded terms is in the | ||
| // search result. | ||
| for (var i = 0; i < excluded.length; i++) { | ||
| if (terms[excluded[i]] == file || | ||
| $.contains(terms[excluded[i]] || [], file)) { | ||
| valid = false; | ||
| break; | ||
| } | ||
| } | ||
| // if we have still a valid result we can add it | ||
| // to the result list | ||
| if (valid) | ||
| regularResults.push([filenames[file], titles[file], '', null]); | ||
| } | ||
| // delete unused variables in order to not waste | ||
| // memory until list is retrieved completely | ||
| delete filenames, titles, terms; | ||
| // now sort the regular results descending by title | ||
| regularResults.sort(function(a, b) { | ||
| var left = a[1].toLowerCase(); | ||
| var right = b[1].toLowerCase(); | ||
| return (left > right) ? -1 : ((left < right) ? 1 : 0); | ||
| }); | ||
| // combine all results | ||
| var results = unimportantResults.concat(regularResults) | ||
| .concat(objectResults).concat(importantResults); | ||
| // print the results | ||
| var resultCount = results.length; | ||
| function displayNextItem() { | ||
| // results left, load the summary and display it | ||
| if (results.length) { | ||
| var item = results.pop(); | ||
| var listItem = $('<li style="display:none"></li>'); | ||
| if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { | ||
| // dirhtml builder | ||
| var dirname = item[0] + '/'; | ||
| if (dirname.match(/\/index\/$/)) { | ||
| dirname = dirname.substring(0, dirname.length-6); | ||
| } else if (dirname == 'index/') { | ||
| dirname = ''; | ||
| } | ||
| listItem.append($('<a/>').attr('href', | ||
| DOCUMENTATION_OPTIONS.URL_ROOT + dirname + | ||
| highlightstring + item[2]).html(item[1])); | ||
| } else { | ||
| // normal html builders | ||
| listItem.append($('<a/>').attr('href', | ||
| item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + | ||
| highlightstring + item[2]).html(item[1])); | ||
| } | ||
| if (item[3]) { | ||
| listItem.append($('<span> (' + item[3] + ')</span>')); | ||
| Search.output.append(listItem); | ||
| listItem.slideDown(5, function() { | ||
| displayNextItem(); | ||
| }); | ||
| } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { | ||
| $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + | ||
| item[0] + '.txt', function(data) { | ||
| if (data != '') { | ||
| listItem.append($.makeSearchSummary(data, searchterms, hlterms)); | ||
| Search.output.append(listItem); | ||
| } | ||
| listItem.slideDown(5, function() { | ||
| displayNextItem(); | ||
| }); | ||
| }); | ||
| } else { | ||
| // no source available, just display title | ||
| Search.output.append(listItem); | ||
| listItem.slideDown(5, function() { | ||
| displayNextItem(); | ||
| }); | ||
| } | ||
| } | ||
| // search finished, update title and status message | ||
| else { | ||
| Search.stopPulse(); | ||
| Search.title.text(_('Search Results')); | ||
| if (!resultCount) | ||
| Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); | ||
| else | ||
| Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); | ||
| Search.status.fadeIn(500); | ||
| } | ||
| } | ||
| displayNextItem(); | ||
| } | ||
| } | ||
| $(document).ready(function() { | ||
| Search.init(); | ||
| }); |
| /* | ||
| * sidebar.js | ||
| * ~~~~~~~~~~ | ||
| * | ||
| * This script makes the Sphinx sidebar collapsible. | ||
| * | ||
| * .sphinxsidebar contains .sphinxsidebarwrapper. This script adds | ||
| * in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton | ||
| * used to collapse and expand the sidebar. | ||
| * | ||
| * When the sidebar is collapsed the .sphinxsidebarwrapper is hidden | ||
| * and the width of the sidebar and the margin-left of the document | ||
| * are decreased. When the sidebar is expanded the opposite happens. | ||
| * This script saves a per-browser/per-session cookie used to | ||
| * remember the position of the sidebar among the pages. | ||
| * Once the browser is closed the cookie is deleted and the position | ||
| * reset to the default (expanded). | ||
| * | ||
| * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. | ||
| * :license: BSD, see LICENSE for details. | ||
| * | ||
| */ | ||
| $(function() { | ||
| // global elements used by the functions. | ||
| // the 'sidebarbutton' element is defined as global after its | ||
| // creation, in the add_sidebar_button function | ||
| var bodywrapper = $('.bodywrapper'); | ||
| var sidebar = $('.sphinxsidebar'); | ||
| var sidebarwrapper = $('.sphinxsidebarwrapper'); | ||
| // original margin-left of the bodywrapper and width of the sidebar | ||
| // with the sidebar expanded | ||
| var bw_margin_expanded = bodywrapper.css('margin-left'); | ||
| var ssb_width_expanded = sidebar.width(); | ||
| // margin-left of the bodywrapper and width of the sidebar | ||
| // with the sidebar collapsed | ||
| var bw_margin_collapsed = '.8em'; | ||
| var ssb_width_collapsed = '.8em'; | ||
| // colors used by the current theme | ||
| var dark_color = $('.related').css('background-color'); | ||
| var light_color = $('.document').css('background-color'); | ||
| function sidebar_is_collapsed() { | ||
| return sidebarwrapper.is(':not(:visible)'); | ||
| } | ||
| function toggle_sidebar() { | ||
| if (sidebar_is_collapsed()) | ||
| expand_sidebar(); | ||
| else | ||
| collapse_sidebar(); | ||
| } | ||
| function collapse_sidebar() { | ||
| sidebarwrapper.hide(); | ||
| sidebar.css('width', ssb_width_collapsed); | ||
| bodywrapper.css('margin-left', bw_margin_collapsed); | ||
| sidebarbutton.css({ | ||
| 'margin-left': '0', | ||
| 'height': bodywrapper.height() | ||
| }); | ||
| sidebarbutton.find('span').text('»'); | ||
| sidebarbutton.attr('title', _('Expand sidebar')); | ||
| document.cookie = 'sidebar=collapsed'; | ||
| } | ||
| function expand_sidebar() { | ||
| bodywrapper.css('margin-left', bw_margin_expanded); | ||
| sidebar.css('width', ssb_width_expanded); | ||
| sidebarwrapper.show(); | ||
| sidebarbutton.css({ | ||
| 'margin-left': ssb_width_expanded-12, | ||
| 'height': bodywrapper.height() | ||
| }); | ||
| sidebarbutton.find('span').text('«'); | ||
| sidebarbutton.attr('title', _('Collapse sidebar')); | ||
| document.cookie = 'sidebar=expanded'; | ||
| } | ||
| function add_sidebar_button() { | ||
| sidebarwrapper.css({ | ||
| 'float': 'left', | ||
| 'margin-right': '0', | ||
| 'width': ssb_width_expanded - 28 | ||
| }); | ||
| // create the button | ||
| sidebar.append( | ||
| '<div id="sidebarbutton"><span>«</span></div>' | ||
| ); | ||
| var sidebarbutton = $('#sidebarbutton'); | ||
| light_color = sidebarbutton.css('background-color'); | ||
| // find the height of the viewport to center the '<<' in the page | ||
| var viewport_height; | ||
| if (window.innerHeight) | ||
| viewport_height = window.innerHeight; | ||
| else | ||
| viewport_height = $(window).height(); | ||
| sidebarbutton.find('span').css({ | ||
| 'display': 'block', | ||
| 'margin-top': (viewport_height - sidebar.position().top - 20) / 2 | ||
| }); | ||
| sidebarbutton.click(toggle_sidebar); | ||
| sidebarbutton.attr('title', _('Collapse sidebar')); | ||
| sidebarbutton.css({ | ||
| 'color': '#FFFFFF', | ||
| 'border-left': '1px solid ' + dark_color, | ||
| 'font-size': '1.2em', | ||
| 'cursor': 'pointer', | ||
| 'height': bodywrapper.height(), | ||
| 'padding-top': '1px', | ||
| 'margin-left': ssb_width_expanded - 12 | ||
| }); | ||
| sidebarbutton.hover( | ||
| function () { | ||
| $(this).css('background-color', dark_color); | ||
| }, | ||
| function () { | ||
| $(this).css('background-color', light_color); | ||
| } | ||
| ); | ||
| } | ||
| function set_position_from_cookie() { | ||
| if (!document.cookie) | ||
| return; | ||
| var items = document.cookie.split(';'); | ||
| for(var k=0; k<items.length; k++) { | ||
| var key_val = items[k].split('='); | ||
| var key = key_val[0]; | ||
| if (key == 'sidebar') { | ||
| var value = key_val[1]; | ||
| if ((value == 'collapsed') && (!sidebar_is_collapsed())) | ||
| collapse_sidebar(); | ||
| else if ((value == 'expanded') && (sidebar_is_collapsed())) | ||
| expand_sidebar(); | ||
| } | ||
| } | ||
| } | ||
| add_sidebar_button(); | ||
| var sidebarbutton = $('#sidebarbutton'); | ||
| set_position_from_cookie(); | ||
| }); |
| (function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e<f;e++)c.call(d, | ||
| a[e],e,a);else{var g=b.keys(a);f=g.length;for(e=0;e<f;e++)c.call(d,a[g[e]],g[e],a)}}catch(h){if(h!=m)throw h;}return a};b.map=function(a,c,d){if(a&&b.isFunction(a.map))return a.map(c,d);var e=[];b.each(a,function(f,g,h){e.push(c.call(d,f,g,h))});return e};b.reduce=function(a,c,d,e){if(a&&b.isFunction(a.reduce))return a.reduce(b.bind(d,e),c);b.each(a,function(f,g,h){c=d.call(e,c,f,g,h)});return c};b.reduceRight=function(a,c,d,e){if(a&&b.isFunction(a.reduceRight))return a.reduceRight(b.bind(d,e),c); | ||
| var f=b.clone(b.toArray(a)).reverse();b.each(f,function(g,h){c=d.call(e,c,g,h,a)});return c};b.detect=function(a,c,d){var e;b.each(a,function(f,g,h){if(c.call(d,f,g,h)){e=f;b.breakLoop()}});return e};b.select=function(a,c,d){if(a&&b.isFunction(a.filter))return a.filter(c,d);var e=[];b.each(a,function(f,g,h){c.call(d,f,g,h)&&e.push(f)});return e};b.reject=function(a,c,d){var e=[];b.each(a,function(f,g,h){!c.call(d,f,g,h)&&e.push(f)});return e};b.all=function(a,c,d){c=c||b.identity;if(a&&b.isFunction(a.every))return a.every(c, | ||
| d);var e=true;b.each(a,function(f,g,h){(e=e&&c.call(d,f,g,h))||b.breakLoop()});return e};b.any=function(a,c,d){c=c||b.identity;if(a&&b.isFunction(a.some))return a.some(c,d);var e=false;b.each(a,function(f,g,h){if(e=c.call(d,f,g,h))b.breakLoop()});return e};b.include=function(a,c){if(b.isArray(a))return b.indexOf(a,c)!=-1;var d=false;b.each(a,function(e){if(d=e===c)b.breakLoop()});return d};b.invoke=function(a,c){var d=b.rest(arguments,2);return b.map(a,function(e){return(c?e[c]:e).apply(e,d)})};b.pluck= | ||
| function(a,c){return b.map(a,function(d){return d[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);var e={computed:-Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;g>=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;g<e.computed&&(e={value:f,computed:g})});return e.value};b.sortBy=function(a,c,d){return b.pluck(b.map(a, | ||
| function(e,f,g){return{value:e,criteria:c.call(d,e,f,g)}}).sort(function(e,f){e=e.criteria;f=f.criteria;return e<f?-1:e>f?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?(e=g+1):(f=g)}return e};b.toArray=function(a){if(!a)return[];if(a.toArray)return a.toArray();if(b.isArray(a))return a;if(b.isArguments(a))return k.call(a);return b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=function(a,c,d){return c&&!d?k.call(a, | ||
| 0,c):a[0]};b.rest=function(a,c,d){return k.call(a,b.isUndefined(c)||d?1:c)};b.last=function(a){return a[a.length-1]};b.compact=function(a){return b.select(a,function(c){return!!c})};b.flatten=function(a){return b.reduce(a,[],function(c,d){if(b.isArray(d))return c.concat(b.flatten(d));c.push(d);return c})};b.without=function(a){var c=b.rest(arguments);return b.select(a,function(d){return!b.include(c,d)})};b.uniq=function(a,c){return b.reduce(a,[],function(d,e,f){if(0==f||(c===true?b.last(d)!=e:!b.include(d, | ||
| e)))d.push(e);return d})};b.intersect=function(a){var c=b.rest(arguments);return b.select(b.uniq(a),function(d){return b.all(c,function(e){return b.indexOf(e,d)>=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e<c;e++)d[e]=b.pluck(a,String(e));return d};b.indexOf=function(a,c){if(a.indexOf)return a.indexOf(c);for(var d=0,e=a.length;d<e;d++)if(a[d]===c)return d;return-1};b.lastIndexOf=function(a,c){if(a.lastIndexOf)return a.lastIndexOf(c);for(var d= | ||
| a.length;d--;)if(a[d]===c)return d;return-1};b.range=function(a,c,d){var e=b.toArray(arguments),f=e.length<=1;a=f?0:e[0];c=f?e[0]:e[1];d=e[2]||1;e=Math.ceil((c-a)/d);if(e<=0)return[];e=new Array(e);f=a;for(var g=0;1;f+=d){if((d>0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); | ||
| return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); | ||
| var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; | ||
| if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== | ||
| 0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& | ||
| a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, | ||
| " ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); | ||
| o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); |
Sorry, the diff of this file is not supported yet
| <!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 Flot Utils v0.2 documentation</title> | ||
| <link rel="stylesheet" href="_static/default.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.2', | ||
| COLLAPSE_INDEX: false, | ||
| FILE_SUFFIX: '.html', | ||
| HAS_SOURCE: true | ||
| }; | ||
| </script> | ||
| <script type="text/javascript" src="_static/jquery.js"></script> | ||
| <script type="text/javascript" src="_static/underscore.js"></script> | ||
| <script type="text/javascript" src="_static/doctools.js"></script> | ||
| <link rel="top" title="Python Flot Utils v0.2 documentation" href="index.html" /> | ||
| </head> | ||
| <body> | ||
| <div class="related"> | ||
| <h3>Navigation</h3> | ||
| <ul> | ||
| <li class="right" style="margin-right: 10px"> | ||
| <a href="#" title="General Index" | ||
| accesskey="I">index</a></li> | ||
| <li><a href="index.html">Python Flot Utils v0.2 documentation</a> »</li> | ||
| </ul> | ||
| </div> | ||
| <div class="document"> | ||
| <div class="documentwrapper"> | ||
| <div class="bodywrapper"> | ||
| <div class="body"> | ||
| <h1 id="index">Index</h1> | ||
| <div class="genindex-jumpbox"> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sphinxsidebar"> | ||
| <div class="sphinxsidebarwrapper"> | ||
| <div id="searchbox" style="display: none"> | ||
| <h3>Quick search</h3> | ||
| <form class="search" action="search.html" method="get"> | ||
| <input type="text" name="q" size="18" /> | ||
| <input type="submit" value="Go" /> | ||
| <input type="hidden" name="check_keywords" value="yes" /> | ||
| <input type="hidden" name="area" value="default" /> | ||
| </form> | ||
| <p class="searchtip" style="font-size: 90%"> | ||
| Enter search terms or a module, class or function name. | ||
| </p> | ||
| </div> | ||
| <script type="text/javascript">$('#searchbox').show(0);</script> | ||
| </div> | ||
| </div> | ||
| <div class="clearer"></div> | ||
| </div> | ||
| <div class="related"> | ||
| <h3>Navigation</h3> | ||
| <ul> | ||
| <li class="right" style="margin-right: 10px"> | ||
| <a href="#" title="General Index" | ||
| >index</a></li> | ||
| <li><a href="index.html">Python Flot Utils v0.2 documentation</a> »</li> | ||
| </ul> | ||
| </div> | ||
| <div class="footer"> | ||
| © Copyright 2011, Brian Luft. | ||
| Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. | ||
| </div> | ||
| </body> | ||
| </html> |
| <!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>Easily Generate Flot Graphs Using Python — Python Flot Utils v0.2 documentation</title> | ||
| <link rel="stylesheet" href="_static/default.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.2', | ||
| COLLAPSE_INDEX: false, | ||
| FILE_SUFFIX: '.html', | ||
| HAS_SOURCE: true | ||
| }; | ||
| </script> | ||
| <script type="text/javascript" src="_static/jquery.js"></script> | ||
| <script type="text/javascript" src="_static/underscore.js"></script> | ||
| <script type="text/javascript" src="_static/doctools.js"></script> | ||
| <link rel="top" title="Python Flot Utils v0.2 documentation" href="#" /> | ||
| </head> | ||
| <body> | ||
| <div class="related"> | ||
| <h3>Navigation</h3> | ||
| <ul> | ||
| <li class="right" style="margin-right: 10px"> | ||
| <a href="genindex.html" title="General Index" | ||
| accesskey="I">index</a></li> | ||
| <li><a href="#">Python Flot Utils v0.2 documentation</a> »</li> | ||
| </ul> | ||
| </div> | ||
| <div class="document"> | ||
| <div class="documentwrapper"> | ||
| <div class="bodywrapper"> | ||
| <div class="body"> | ||
| <div class="section" id="easily-generate-flot-graphs-using-python"> | ||
| <h1>Easily Generate Flot Graphs Using Python<a class="headerlink" href="#easily-generate-flot-graphs-using-python" title="Permalink to this headline">¶</a></h1> | ||
| <p>PyFlot makes it easy to generate <a class="reference external" href="http://code.google.com/p/flot/">flot</a> graphs. Its primary goal is to | ||
| allow one to specify data inputs and options in a Python application | ||
| and generate the appropriate JSON. Common uses of this will be rendering | ||
| into a template as flot() arguments or as the payload of an XHR response. | ||
| PyFlot takes care of all the annoying details of converting types to match | ||
| up with how <cite>flot</cite> expects them.</p> | ||
| <p>For example:</p> | ||
| <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyflot</span> | ||
| <span class="gp">>>> </span><span class="n">graph</span> <span class="o">=</span> <span class="n">pyflot</span><span class="o">.</span><span class="n">Flot</span><span class="p">()</span> | ||
| <span class="gp">>>> </span><span class="n">graph</span><span class="o">.</span><span class="n">add_line</span><span class="p">([(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">3</span><span class="p">)])</span> | ||
| <span class="gp">>>> </span><span class="k">print</span> <span class="n">graph</span><span class="o">.</span><span class="n">series_json</span> | ||
| <span class="go">[{"data": [[1, 1], [2, 2], [3, 3]]}]</span> | ||
| </pre></div> | ||
| </div> | ||
| <p>In this simple example the <tt class="docutils literal"><span class="pre">series_json</span></tt> is a JSON string | ||
| in the format expected by <tt class="docutils literal"><span class="pre">flot</span></tt>.</p> | ||
| <p>The following Django template snippet shows how you might use | ||
| it in a Django template:</p> | ||
| <div class="highlight-HTML+Django/Jinja"><pre><script id="source" language="javascript" type="text/javascript"> | ||
| $(function () { | ||
| $.plot($("#linear-graph"), {{ graph.series_json|safe }}, {{ graph.options_json|safe }}); | ||
| }); | ||
| </script></pre> | ||
| </div> | ||
| <div class="toctree-wrapper compound"> | ||
| <ul class="simple"> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| <div class="section" id="indices-and-tables"> | ||
| <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1> | ||
| <ul class="simple"> | ||
| <li><a class="reference internal" href="genindex.html"><em>Index</em></a></li> | ||
| <li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li> | ||
| <li><a class="reference internal" href="search.html"><em>Search Page</em></a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sphinxsidebar"> | ||
| <div class="sphinxsidebarwrapper"> | ||
| <h3><a href="#">Table Of Contents</a></h3> | ||
| <ul> | ||
| <li><a class="reference internal" href="#">Easily Generate Flot Graphs Using Python</a><ul> | ||
| </ul> | ||
| </li> | ||
| <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> | ||
| </ul> | ||
| <h3>This Page</h3> | ||
| <ul class="this-page-menu"> | ||
| <li><a href="_sources/index.txt" | ||
| rel="nofollow">Show Source</a></li> | ||
| </ul> | ||
| <div id="searchbox" style="display: none"> | ||
| <h3>Quick search</h3> | ||
| <form class="search" action="search.html" method="get"> | ||
| <input type="text" name="q" size="18" /> | ||
| <input type="submit" value="Go" /> | ||
| <input type="hidden" name="check_keywords" value="yes" /> | ||
| <input type="hidden" name="area" value="default" /> | ||
| </form> | ||
| <p class="searchtip" style="font-size: 90%"> | ||
| Enter search terms or a module, class or function name. | ||
| </p> | ||
| </div> | ||
| <script type="text/javascript">$('#searchbox').show(0);</script> | ||
| </div> | ||
| </div> | ||
| <div class="clearer"></div> | ||
| </div> | ||
| <div class="related"> | ||
| <h3>Navigation</h3> | ||
| <ul> | ||
| <li class="right" style="margin-right: 10px"> | ||
| <a href="genindex.html" title="General Index" | ||
| >index</a></li> | ||
| <li><a href="#">Python Flot Utils v0.2 documentation</a> »</li> | ||
| </ul> | ||
| </div> | ||
| <div class="footer"> | ||
| © Copyright 2011, Brian Luft. | ||
| Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. | ||
| </div> | ||
| </body> | ||
| </html> |
Sorry, the diff of this file is not supported yet
| <!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 Flot Utils v0.2 documentation</title> | ||
| <link rel="stylesheet" href="_static/default.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.2', | ||
| COLLAPSE_INDEX: false, | ||
| FILE_SUFFIX: '.html', | ||
| HAS_SOURCE: true | ||
| }; | ||
| </script> | ||
| <script type="text/javascript" src="_static/jquery.js"></script> | ||
| <script type="text/javascript" src="_static/underscore.js"></script> | ||
| <script type="text/javascript" src="_static/doctools.js"></script> | ||
| <script type="text/javascript" src="_static/searchtools.js"></script> | ||
| <link rel="top" title="Python Flot Utils v0.2 documentation" href="index.html" /> | ||
| <script type="text/javascript"> | ||
| jQuery(function() { Search.loadIndex("searchindex.js"); }); | ||
| </script> | ||
| </head> | ||
| <body> | ||
| <div class="related"> | ||
| <h3>Navigation</h3> | ||
| <ul> | ||
| <li class="right" style="margin-right: 10px"> | ||
| <a href="genindex.html" title="General Index" | ||
| accesskey="I">index</a></li> | ||
| <li><a href="index.html">Python Flot Utils v0.2 documentation</a> »</li> | ||
| </ul> | ||
| </div> | ||
| <div class="document"> | ||
| <div class="documentwrapper"> | ||
| <div class="bodywrapper"> | ||
| <div class="body"> | ||
| <h1 id="search-documentation">Search</h1> | ||
| <div id="fallback" class="admonition warning"> | ||
| <script type="text/javascript">$('#fallback').hide();</script> | ||
| <p> | ||
| Please activate JavaScript to enable the search | ||
| functionality. | ||
| </p> | ||
| </div> | ||
| <p> | ||
| From here you can search these documents. Enter your search | ||
| words into the box below and click "search". Note that the search | ||
| function will automatically search for all of the words. Pages | ||
| containing fewer words won't appear in the result list. | ||
| </p> | ||
| <form action="" method="get"> | ||
| <input type="text" name="q" value="" /> | ||
| <input type="submit" value="search" /> | ||
| <span id="search-progress" style="padding-left: 10px"></span> | ||
| </form> | ||
| <div id="search-results"> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div class="sphinxsidebar"> | ||
| <div class="sphinxsidebarwrapper"> | ||
| </div> | ||
| </div> | ||
| <div class="clearer"></div> | ||
| </div> | ||
| <div class="related"> | ||
| <h3>Navigation</h3> | ||
| <ul> | ||
| <li class="right" style="margin-right: 10px"> | ||
| <a href="genindex.html" title="General Index" | ||
| >index</a></li> | ||
| <li><a href="index.html">Python Flot Utils v0.2 documentation</a> »</li> | ||
| </ul> | ||
| </div> | ||
| <div class="footer"> | ||
| © Copyright 2011, Brian Luft. | ||
| Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. | ||
| </div> | ||
| </body> | ||
| </html> |
| Search.setIndex({objects:{},terms:{all:0,render:0,show:0,text:0,modul:0,respons:0,django:0,argument:0,indic:0,javascript:0,expect:0,tabl:0,follow:0,simpl:0,easili:0,primari:0,languag:0,string:0,index:0,welcom:[],easi:0,script:0,pyflot:0,graph:0,make:0,detail:0,payload:0,content:[],how:0,json:0,snippet:0,take:0,print:0,"import":0,you:0,document:[],type:0,match:0,"function":0,applic:0,them:0,sourc:0,option:0,format:0,python:0,gener:0,safe:0,search:0,specifi:0,util:[],templat:0,options_json:0,data:0,add_lin:0,goal:0,convert:0,appropri:0,input:0,add_seri:[],might:0,linear:0,series_json:0,plot:0,flot:0,annoi:0,xhr:0,exampl:0,allow:0,common:0,thi:0,page:0,care:0},objtypes:{},titles:["Easily Generate Flot Graphs Using Python"],objnames:{},filenames:["index"]}) |
+256
| # -*- coding: utf-8 -*- | ||
| # | ||
| # Python Flot Utils documentation build configuration file, created by | ||
| # sphinx-quickstart on Thu Feb 17 16:27:52 2011. | ||
| # | ||
| # This file is execfile()d with the current directory set to its containing dir. | ||
| # | ||
| # Note that not all possible configuration values are present in this | ||
| # autogenerated file. | ||
| # | ||
| # All configuration values have a default; values that are commented out | ||
| # serve to show the default. | ||
| import sys, os | ||
| # If extensions (or modules to document with autodoc) are in another directory, | ||
| # add these directories to sys.path here. If the directory is relative to the | ||
| # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| #sys.path.insert(0, os.path.abspath('.')) | ||
| # -- General configuration ----------------------------------------------------- | ||
| # If your documentation needs a minimal Sphinx version, state it here. | ||
| #needs_sphinx = '1.0' | ||
| # Add any Sphinx extension module names here, as strings. They can be extensions | ||
| # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
| extensions = [] | ||
| # Add any paths that contain templates here, relative to this directory. | ||
| templates_path = ['_templates'] | ||
| # The suffix of source filenames. | ||
| source_suffix = '.rst' | ||
| # The encoding of source files. | ||
| #source_encoding = 'utf-8-sig' | ||
| # The master toctree document. | ||
| master_doc = 'index' | ||
| # General information about the project. | ||
| project = u'Python Flot Utils' | ||
| copyright = u'2011, Brian Luft' | ||
| # The version info for the project you're documenting, acts as replacement for | ||
| # |version| and |release|, also used in various other places throughout the | ||
| # built documents. | ||
| # | ||
| # The short X.Y version. | ||
| version = '0.2' | ||
| # The full version, including alpha/beta/rc tags. | ||
| release = '0.2.1' | ||
| # The language for content autogenerated by Sphinx. Refer to documentation | ||
| # for a list of supported languages. | ||
| #language = None | ||
| # There are two options for replacing |today|: either, you set today to some | ||
| # non-false value, then it is used: | ||
| #today = '' | ||
| # Else, today_fmt is used as the format for a strftime call. | ||
| #today_fmt = '%B %d, %Y' | ||
| # List of patterns, relative to source directory, that match files and | ||
| # directories to ignore when looking for source files. | ||
| exclude_patterns = ['_build'] | ||
| # The reST default role (used for this markup: `text`) to use for all documents. | ||
| #default_role = None | ||
| # If true, '()' will be appended to :func: etc. cross-reference text. | ||
| #add_function_parentheses = True | ||
| # If true, the current module name will be prepended to all description | ||
| # unit titles (such as .. function::). | ||
| #add_module_names = True | ||
| # If true, sectionauthor and moduleauthor directives will be shown in the | ||
| # output. They are ignored by default. | ||
| #show_authors = False | ||
| # The name of the Pygments (syntax highlighting) style to use. | ||
| pygments_style = 'sphinx' | ||
| # A list of ignored prefixes for module index sorting. | ||
| #modindex_common_prefix = [] | ||
| # -- Options for HTML output --------------------------------------------------- | ||
| # The theme to use for HTML and HTML Help pages. See the documentation for | ||
| # a list of builtin themes. | ||
| html_theme = 'default' | ||
| # Theme options are theme-specific and customize the look and feel of a theme | ||
| # further. For a list of options available for each theme, see the | ||
| # documentation. | ||
| #html_theme_options = {} | ||
| # Add any paths that contain custom themes here, relative to this directory. | ||
| #html_theme_path = [] | ||
| # The name for this set of Sphinx documents. If None, it defaults to | ||
| # "<project> v<release> documentation". | ||
| #html_title = None | ||
| # A shorter title for the navigation bar. Default is the same as html_title. | ||
| #html_short_title = None | ||
| # The name of an image file (relative to this directory) to place at the top | ||
| # of the sidebar. | ||
| #html_logo = None | ||
| # The name of an image file (within the static path) to use as favicon of the | ||
| # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
| # pixels large. | ||
| #html_favicon = None | ||
| # Add any paths that contain custom static files (such as style sheets) here, | ||
| # relative to this directory. They are copied after the builtin static files, | ||
| # so a file named "default.css" will overwrite the builtin "default.css". | ||
| html_static_path = ['_static'] | ||
| # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
| # using the given strftime format. | ||
| #html_last_updated_fmt = '%b %d, %Y' | ||
| # If true, SmartyPants will be used to convert quotes and dashes to | ||
| # typographically correct entities. | ||
| #html_use_smartypants = True | ||
| # Custom sidebar templates, maps document names to template names. | ||
| #html_sidebars = {} | ||
| # Additional templates that should be rendered to pages, maps page names to | ||
| # template names. | ||
| #html_additional_pages = {} | ||
| # If false, no module index is generated. | ||
| #html_domain_indices = True | ||
| # If false, no index is generated. | ||
| #html_use_index = True | ||
| # If true, the index is split into individual pages for each letter. | ||
| #html_split_index = False | ||
| # If true, links to the reST sources are added to the pages. | ||
| #html_show_sourcelink = True | ||
| # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | ||
| #html_show_sphinx = True | ||
| # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | ||
| #html_show_copyright = True | ||
| # If true, an OpenSearch description file will be output, and all pages will | ||
| # contain a <link> tag referring to it. The value of this option must be the | ||
| # base URL from which the finished HTML is served. | ||
| #html_use_opensearch = '' | ||
| # This is the file name suffix for HTML files (e.g. ".xhtml"). | ||
| #html_file_suffix = None | ||
| # Output file base name for HTML help builder. | ||
| htmlhelp_basename = 'PythonFlotUtilsdoc' | ||
| # -- Options for LaTeX output -------------------------------------------------- | ||
| # The paper size ('letter' or 'a4'). | ||
| #latex_paper_size = 'letter' | ||
| # The font size ('10pt', '11pt' or '12pt'). | ||
| #latex_font_size = '10pt' | ||
| # Grouping the document tree into LaTeX files. List of tuples | ||
| # (source start file, target name, title, author, documentclass [howto/manual]). | ||
| latex_documents = [ | ||
| ('index', 'PythonFlotUtils.tex', u'Python Flot Utils Documentation', | ||
| u'Brian Luft', 'manual'), | ||
| ] | ||
| # The name of an image file (relative to this directory) to place at the top of | ||
| # the title page. | ||
| #latex_logo = None | ||
| # For "manual" documents, if this is true, then toplevel headings are parts, | ||
| # not chapters. | ||
| #latex_use_parts = False | ||
| # If true, show page references after internal links. | ||
| #latex_show_pagerefs = False | ||
| # If true, show URL addresses after external links. | ||
| #latex_show_urls = False | ||
| # Additional stuff for the LaTeX preamble. | ||
| #latex_preamble = '' | ||
| # Documents to append as an appendix to all manuals. | ||
| #latex_appendices = [] | ||
| # If false, no module index is generated. | ||
| #latex_domain_indices = True | ||
| # -- Options for manual page output -------------------------------------------- | ||
| # One entry per manual page. List of tuples | ||
| # (source start file, name, description, authors, manual section). | ||
| man_pages = [ | ||
| ('index', 'pythonflotutils', u'Python Flot Utils Documentation', | ||
| [u'Brian Luft'], 1) | ||
| ] | ||
| # -- Options for Epub output --------------------------------------------------- | ||
| # Bibliographic Dublin Core info. | ||
| epub_title = u'Python Flot Utils' | ||
| epub_author = u'Brian Luft' | ||
| epub_publisher = u'Brian Luft' | ||
| epub_copyright = u'2011, Brian Luft' | ||
| # The language of the text. It defaults to the language option | ||
| # or en if the language is not set. | ||
| #epub_language = '' | ||
| # The scheme of the identifier. Typical schemes are ISBN or URL. | ||
| #epub_scheme = '' | ||
| # The unique identifier of the text. This can be a ISBN number | ||
| # or the project homepage. | ||
| #epub_identifier = '' | ||
| # A unique identification for the text. | ||
| #epub_uid = '' | ||
| # HTML files that should be inserted before the pages created by sphinx. | ||
| # The format is a list of tuples containing the path and title. | ||
| #epub_pre_files = [] | ||
| # HTML files shat should be inserted after the pages created by sphinx. | ||
| # The format is a list of tuples containing the path and title. | ||
| #epub_post_files = [] | ||
| # A list of files that should not be packed into the epub file. | ||
| #epub_exclude_files = [] | ||
| # The depth of the table of contents in toc.ncx. | ||
| #epub_tocdepth = 3 | ||
| # Allow duplicate toc entries. | ||
| #epub_tocdup = True |
| .. Python Flot Utils documentation master file, created by | ||
| sphinx-quickstart on Thu Feb 17 16:27:52 2011. | ||
| You can adapt this file completely to your liking, but it should at least | ||
| contain the root `toctree` directive. | ||
| Easily Generate Flot Graphs Using Python | ||
| ======================================== | ||
| PyFlot makes it easy to generate flot_ graphs. Its primary goal is to | ||
| allow one to specify data inputs and options in a Python application | ||
| and generate the appropriate JSON. Common uses of this will be rendering | ||
| into a template as flot() arguments or as the payload of an XHR response. | ||
| PyFlot takes care of all the annoying details of converting types to match | ||
| up with how `flot` expects them. | ||
| For example:: | ||
| >>> import pyflot | ||
| >>> graph = pyflot.Flot() | ||
| >>> graph.add_line([(1, 1), (2, 2), (3, 3)]) | ||
| >>> print graph.series_json | ||
| [{"data": [[1, 1], [2, 2], [3, 3]]}] | ||
| In this simple example the ``series_json`` is a JSON string | ||
| in the format expected by ``flot``. | ||
| The following Django template snippet shows how you might use | ||
| it in a Django template: | ||
| .. code-block:: HTML+Django/Jinja | ||
| <script id="source" language="javascript" type="text/javascript"> | ||
| $(function () { | ||
| $.plot($("#linear-graph"), {{ graph.series_json|safe }}, {{ graph.options_json|safe }}); | ||
| }); | ||
| </script> | ||
| .. _flot: http://code.google.com/p/flot/ | ||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| Indices and tables | ||
| ================== | ||
| * :ref:`genindex` | ||
| * :ref:`modindex` | ||
| * :ref:`search` | ||
+170
| @ECHO OFF | ||
| REM Command file for Sphinx documentation | ||
| if "%SPHINXBUILD%" == "" ( | ||
| set SPHINXBUILD=sphinx-build | ||
| ) | ||
| set BUILDDIR=_build | ||
| set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . | ||
| if NOT "%PAPER%" == "" ( | ||
| set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% | ||
| ) | ||
| if "%1" == "" goto help | ||
| if "%1" == "help" ( | ||
| :help | ||
| echo.Please use `make ^<target^>` where ^<target^> is one of | ||
| echo. html to make standalone HTML files | ||
| echo. dirhtml to make HTML files named index.html in directories | ||
| echo. singlehtml to make a single large HTML file | ||
| echo. pickle to make pickle files | ||
| echo. json to make JSON files | ||
| echo. htmlhelp to make HTML files and a HTML help project | ||
| echo. qthelp to make HTML files and a qthelp project | ||
| echo. devhelp to make HTML files and a Devhelp project | ||
| echo. epub to make an epub | ||
| echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter | ||
| echo. text to make text files | ||
| echo. man to make manual pages | ||
| echo. changes to make an overview over all changed/added/deprecated items | ||
| echo. linkcheck to check all external links for integrity | ||
| echo. doctest to run all doctests embedded in the documentation if enabled | ||
| goto end | ||
| ) | ||
| if "%1" == "clean" ( | ||
| for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i | ||
| del /q /s %BUILDDIR%\* | ||
| goto end | ||
| ) | ||
| if "%1" == "html" ( | ||
| %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The HTML pages are in %BUILDDIR%/html. | ||
| goto end | ||
| ) | ||
| if "%1" == "dirhtml" ( | ||
| %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. | ||
| goto end | ||
| ) | ||
| if "%1" == "singlehtml" ( | ||
| %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. | ||
| goto end | ||
| ) | ||
| if "%1" == "pickle" ( | ||
| %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished; now you can process the pickle files. | ||
| goto end | ||
| ) | ||
| if "%1" == "json" ( | ||
| %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished; now you can process the JSON files. | ||
| goto end | ||
| ) | ||
| if "%1" == "htmlhelp" ( | ||
| %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished; now you can run HTML Help Workshop with the ^ | ||
| .hhp project file in %BUILDDIR%/htmlhelp. | ||
| goto end | ||
| ) | ||
| if "%1" == "qthelp" ( | ||
| %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished; now you can run "qcollectiongenerator" with the ^ | ||
| .qhcp project file in %BUILDDIR%/qthelp, like this: | ||
| echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PythonFlotUtils.qhcp | ||
| echo.To view the help file: | ||
| echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PythonFlotUtils.ghc | ||
| goto end | ||
| ) | ||
| if "%1" == "devhelp" ( | ||
| %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. | ||
| goto end | ||
| ) | ||
| if "%1" == "epub" ( | ||
| %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The epub file is in %BUILDDIR%/epub. | ||
| goto end | ||
| ) | ||
| if "%1" == "latex" ( | ||
| %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. | ||
| goto end | ||
| ) | ||
| if "%1" == "text" ( | ||
| %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The text files are in %BUILDDIR%/text. | ||
| goto end | ||
| ) | ||
| if "%1" == "man" ( | ||
| %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Build finished. The manual pages are in %BUILDDIR%/man. | ||
| goto end | ||
| ) | ||
| if "%1" == "changes" ( | ||
| %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.The overview file is in %BUILDDIR%/changes. | ||
| goto end | ||
| ) | ||
| if "%1" == "linkcheck" ( | ||
| %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Link check complete; look for any errors in the above output ^ | ||
| or in %BUILDDIR%/linkcheck/output.txt. | ||
| goto end | ||
| ) | ||
| if "%1" == "doctest" ( | ||
| %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest | ||
| if errorlevel 1 exit /b 1 | ||
| echo. | ||
| echo.Testing of doctests in the sources finished, look at the ^ | ||
| results in %BUILDDIR%/doctest/output.txt. | ||
| goto end | ||
| ) | ||
| :end |
+130
| # Makefile for Sphinx documentation | ||
| # | ||
| # You can set these variables from the command line. | ||
| SPHINXOPTS = | ||
| SPHINXBUILD = sphinx-build | ||
| PAPER = | ||
| BUILDDIR = _build | ||
| # Internal variables. | ||
| PAPEROPT_a4 = -D latex_paper_size=a4 | ||
| PAPEROPT_letter = -D latex_paper_size=letter | ||
| ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
| .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest | ||
| help: | ||
| @echo "Please use \`make <target>' where <target> is one of" | ||
| @echo " html to make standalone HTML files" | ||
| @echo " dirhtml to make HTML files named index.html in directories" | ||
| @echo " singlehtml to make a single large HTML file" | ||
| @echo " pickle to make pickle files" | ||
| @echo " json to make JSON files" | ||
| @echo " htmlhelp to make HTML files and a HTML help project" | ||
| @echo " qthelp to make HTML files and a qthelp project" | ||
| @echo " devhelp to make HTML files and a Devhelp project" | ||
| @echo " epub to make an epub" | ||
| @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | ||
| @echo " latexpdf to make LaTeX files and run them through pdflatex" | ||
| @echo " text to make text files" | ||
| @echo " man to make manual pages" | ||
| @echo " changes to make an overview of all changed/added/deprecated items" | ||
| @echo " linkcheck to check all external links for integrity" | ||
| @echo " doctest to run all doctests embedded in the documentation (if enabled)" | ||
| clean: | ||
| -rm -rf $(BUILDDIR)/* | ||
| html: | ||
| $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
| @echo | ||
| @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | ||
| dirhtml: | ||
| $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | ||
| @echo | ||
| @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." | ||
| singlehtml: | ||
| $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml | ||
| @echo | ||
| @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." | ||
| pickle: | ||
| $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle | ||
| @echo | ||
| @echo "Build finished; now you can process the pickle files." | ||
| json: | ||
| $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json | ||
| @echo | ||
| @echo "Build finished; now you can process the JSON files." | ||
| htmlhelp: | ||
| $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp | ||
| @echo | ||
| @echo "Build finished; now you can run HTML Help Workshop with the" \ | ||
| ".hhp project file in $(BUILDDIR)/htmlhelp." | ||
| qthelp: | ||
| $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp | ||
| @echo | ||
| @echo "Build finished; now you can run "qcollectiongenerator" with the" \ | ||
| ".qhcp project file in $(BUILDDIR)/qthelp, like this:" | ||
| @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PythonFlotUtils.qhcp" | ||
| @echo "To view the help file:" | ||
| @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonFlotUtils.qhc" | ||
| devhelp: | ||
| $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | ||
| @echo | ||
| @echo "Build finished." | ||
| @echo "To view the help file:" | ||
| @echo "# mkdir -p $$HOME/.local/share/devhelp/PythonFlotUtils" | ||
| @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonFlotUtils" | ||
| @echo "# devhelp" | ||
| epub: | ||
| $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | ||
| @echo | ||
| @echo "Build finished. The epub file is in $(BUILDDIR)/epub." | ||
| latex: | ||
| $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| @echo | ||
| @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." | ||
| @echo "Run \`make' in that directory to run these through (pdf)latex" \ | ||
| "(use \`make latexpdf' here to do that automatically)." | ||
| latexpdf: | ||
| $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| @echo "Running LaTeX files through pdflatex..." | ||
| make -C $(BUILDDIR)/latex all-pdf | ||
| @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | ||
| text: | ||
| $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text | ||
| @echo | ||
| @echo "Build finished. The text files are in $(BUILDDIR)/text." | ||
| man: | ||
| $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man | ||
| @echo | ||
| @echo "Build finished. The manual pages are in $(BUILDDIR)/man." | ||
| changes: | ||
| $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | ||
| @echo | ||
| @echo "The overview file is in $(BUILDDIR)/changes." | ||
| linkcheck: | ||
| $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | ||
| @echo | ||
| @echo "Link check complete; look for any errors in the above output " \ | ||
| "or in $(BUILDDIR)/linkcheck/output.txt." | ||
| doctest: | ||
| $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | ||
| @echo "Testing of doctests in the sources finished, look at the " \ | ||
| "results in $(BUILDDIR)/doctest/output.txt." |
+19
| Copyright (c) 2011 Brian Luft | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in | ||
| all copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| THE SOFTWARE. |
| include LICENSE README.rst | ||
| recursive-include tests * | ||
| recursive-include docs * | ||
| recursive-exclude docs *.pyc | ||
| recursive-exclude docs *.pyo | ||
| recursive-exclude tests *.pyc | ||
| recursive-exclude tests *.pyo | ||
| prune docs/_build/doctrees |
+34
| python-flot-utils | ||
| ================= | ||
| PyFlot makes it easy to generate flot_ graphs. Its primary goal is to | ||
| allow one to specify data inputs and options in a Python application | ||
| and generate the appropriate JSON. Common uses of this will be rendering | ||
| into a template as flot() arguments or as the payload of an XHR response. | ||
| PyFlot takes care of all the annoying details of converting types to match | ||
| up with how `flot` expects them. | ||
| For example:: | ||
| >>> import pyflot | ||
| >>> graph = pyflot.Flot() | ||
| >>> graph.add_line([(1, 1), (2, 2), (3, 3)]) | ||
| >>> print graph.series_json | ||
| [{"data": [[1, 1], [2, 2], [3, 3]]}] | ||
| In this simple example the ``series_json`` is a JSON string | ||
| in the format expected by ``flot``. | ||
| The following Django template snippet shows how you might use | ||
| it in a Django template:: | ||
| <script id="source" language="javascript" type="text/javascript"> | ||
| $(function () { | ||
| $.plot($("#linear-graph"), {{ graph.series_json|safe }}, {{ graph.options_json|safe }}); | ||
| }); | ||
| </script> | ||
| .. _flot: http://code.google.com/p/flot/ |
+1
-1
| Metadata-Version: 1.0 | ||
| Name: python-flot-utils | ||
| Version: 0.2 | ||
| Version: 0.2.1 | ||
| Summary: Makes it easy to convert Python data structures to JSON strings suitable for flot series and options | ||
@@ -5,0 +5,0 @@ Home-page: UNKNOWN |
| Metadata-Version: 1.0 | ||
| Name: python-flot-utils | ||
| Version: 0.2 | ||
| Version: 0.2.1 | ||
| Summary: Makes it easy to convert Python data structures to JSON strings suitable for flot series and options | ||
@@ -5,0 +5,0 @@ Home-page: UNKNOWN |
@@ -0,2 +1,27 @@ | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| setup.py | ||
| docs/Makefile | ||
| docs/conf.py | ||
| docs/index.rst | ||
| docs/make.bat | ||
| docs/_build/html/.buildinfo | ||
| docs/_build/html/genindex.html | ||
| docs/_build/html/index.html | ||
| docs/_build/html/objects.inv | ||
| docs/_build/html/search.html | ||
| docs/_build/html/searchindex.js | ||
| docs/_build/html/_sources/index.txt | ||
| docs/_build/html/_static/basic.css | ||
| docs/_build/html/_static/default.css | ||
| docs/_build/html/_static/doctools.js | ||
| docs/_build/html/_static/file.png | ||
| docs/_build/html/_static/jquery.js | ||
| docs/_build/html/_static/minus.png | ||
| docs/_build/html/_static/plus.png | ||
| docs/_build/html/_static/pygments.css | ||
| docs/_build/html/_static/searchtools.js | ||
| docs/_build/html/_static/sidebar.js | ||
| docs/_build/html/_static/underscore.js | ||
| pyflot/__init__.py | ||
@@ -3,0 +28,0 @@ python_flot_utils.egg-info/PKG-INFO |
+1
-1
@@ -9,3 +9,3 @@ import os | ||
| name = "python-flot-utils", | ||
| version = "0.2", | ||
| version = "0.2.1", | ||
| author = "Brian Luft", | ||
@@ -12,0 +12,0 @@ author_email = "brian@unbracketed.com", |
Alert delta unavailable
Currently unable to show alert delta for PyPI packages.
174806
1079.45%34
277.78%2323
760.37%