Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

new documentation build with working stack (on gameclosure server)

  • Loading branch information...
commit 6c8d15daf14b37fc84ec5861222407ff1db2ea8b 1 parent 4845d80
@mcarter mcarter authored
Showing with 6,092 additions and 1,017 deletions.
  1. BIN  docs/build/doctrees/compilation.doctree
  2. BIN  docs/build/doctrees/configuration.doctree
  3. BIN  docs/build/doctrees/deployment.doctree
  4. BIN  docs/build/doctrees/environment.pickle
  5. BIN  docs/build/doctrees/index.doctree
  6. BIN  docs/build/doctrees/intro.doctree
  7. BIN  docs/build/doctrees/tcpsocket.doctree
  8. BIN  docs/build/doctrees/under_the_hood.doctree
  9. BIN  docs/build/doctrees/websocket.doctree
  10. +1 −1  docs/build/html/.buildinfo
  11. +7 −130 docs/build/html/_static/basic.css
  12. +10 −69 docs/build/html/_static/default.css
  13. +22 −37 docs/build/html/_static/doctools.js
  14. +4,371 −149 docs/build/html/_static/jquery.js
  15. +61 −62 docs/build/html/_static/pygments.css
  16. +230 −141 docs/build/html/_static/searchtools.js
  17. +146 −42 docs/build/html/compilation.html
  18. +211 −44 docs/build/html/configuration.html
  19. +122 −42 docs/build/html/deployment.html
  20. +109 −43 docs/build/html/genindex.html
  21. +131 −42 docs/build/html/index.html
  22. +203 −44 docs/build/html/intro.html
  23. BIN  docs/build/html/objects.inv
  24. +119 −44 docs/build/html/search.html
  25. +1 −1  docs/build/html/searchindex.js
  26. +116 −42 docs/build/html/tcpsocket.html
  27. +116 −42 docs/build/html/under_the_hood.html
  28. +116 −42 docs/build/html/websocket.html
View
BIN  docs/build/doctrees/compilation.doctree
Binary file not shown
View
BIN  docs/build/doctrees/configuration.doctree
Binary file not shown
View
BIN  docs/build/doctrees/deployment.doctree
Binary file not shown
View
BIN  docs/build/doctrees/environment.pickle
Binary file not shown
View
BIN  docs/build/doctrees/index.doctree
Binary file not shown
View
BIN  docs/build/doctrees/intro.doctree
Binary file not shown
View
BIN  docs/build/doctrees/tcpsocket.doctree
Binary file not shown
View
BIN  docs/build/doctrees/under_the_hood.doctree
Binary file not shown
View
BIN  docs/build/doctrees/websocket.doctree
Binary file not shown
View
2  docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7e86eccc770d22aa29c6d6ee9a0cb9d0
+config: d14059706370c86b2bd2ca452d8be6b9
tags: fbb0d17656682115ca4d033fb2f83ba1
View
137 docs/build/html/_static/basic.css
@@ -1,12 +1,6 @@
-/*
- * basic.css
- * ~~~~~~~~~
- *
- * Sphinx stylesheet -- basic theme.
- *
- * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
+/**
+ * Sphinx stylesheet -- basic theme
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/* -- main layout ----------------------------------------------------------- */
@@ -49,7 +43,7 @@ div.sphinxsidebarwrapper {
div.sphinxsidebar {
float: left;
- width: {{ theme_sidebarwidth|toint }}px;
+ width: 230px;
margin-left: -100%;
font-size: 90%;
}
@@ -79,14 +73,6 @@ div.sphinxsidebar input {
font-size: 1em;
}
-div.sphinxsidebar input[type="text"] {
- width: 170px;
-}
-
-div.sphinxsidebar input[type="submit"] {
- width: 30px;
-}
-
img {
border: 0;
}
@@ -141,10 +127,6 @@ span.linkdescr {
/* -- general index --------------------------------------------------------- */
-table.indextable {
- width: 100%;
-}
-
table.indextable td {
text-align: left;
vertical-align: top;
@@ -170,20 +152,6 @@ img.toggler {
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 {
@@ -221,36 +189,6 @@ p.rubric {
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 {
- text-align: center;
-}
-
-.align-right {
- text-align: right;
-}
-
/* -- sidebars -------------------------------------------------------------- */
div.sidebar {
@@ -314,7 +252,7 @@ table.docutils {
}
table.docutils td, table.docutils th {
- padding: 1px 8px 1px 5px;
+ padding: 1px 8px 1px 0;
border-top: 0;
border-left: 0;
border-right: 0;
@@ -334,37 +272,8 @@ th {
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;
}
@@ -383,7 +292,7 @@ dd {
margin-left: 30px;
}
-dt:target, .highlighted {
+dt:target, .highlight {
background-color: #fbe54e;
}
@@ -420,7 +329,7 @@ dl.glossary dt {
}
.footnote:target {
- background-color: #ffa;
+ background-color: #ffa
}
.line-block {
@@ -435,28 +344,10 @@ dl.glossary dt {
margin-left: 1.5em;
}
-.guilabel, .menuselection {
- font-family: sans-serif;
-}
-
-.accelerator {
- text-decoration: underline;
-}
-
-.classifier {
- font-style: oblique;
-}
-
-abbr, acronym {
- border-bottom: dotted 1px;
- cursor: help;
-}
-
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
- overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
td.linenos pre {
@@ -493,20 +384,6 @@ 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 {
View
79 docs/build/html/_static/default.css
@@ -1,12 +1,6 @@
-/*
- * default.css_t
- * ~~~~~~~~~~~~~
- *
- * Sphinx stylesheet -- default theme.
- *
- * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
+/**
+ * Sphinx stylesheet -- default theme
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
@import url("basic.css");
@@ -32,7 +26,7 @@ div.documentwrapper {
}
div.bodywrapper {
- margin: 0 0 0 {{ theme_sidebarwidth|toint }}px;
+ margin: 0 0 0 230px;
}
div.body {
@@ -43,7 +37,7 @@ div.body {
{%- if theme_rightsidebar|tobool %}
div.bodywrapper {
- margin: 0 {{ theme_sidebarwidth|toint }}px 0 0;
+ margin: 0 230px 0 0;
}
{%- endif %}
@@ -73,11 +67,10 @@ div.related a {
div.sphinxsidebar {
{%- if theme_stickysidebar|tobool %}
top: 30px;
- bottom: 0;
margin: 0;
position: fixed;
overflow: auto;
- height: auto;
+ height: 100%;
{%- endif %}
{%- if theme_rightsidebar|tobool %}
float: right;
@@ -147,47 +140,21 @@ div.sphinxsidebar input {
font-size: 1em;
}
-{% if theme_collapsiblesidebar|tobool %}
-/* for collapsible sidebar */
-div#sidebarbutton {
- background-color: {{ theme_sidebarbtncolor }};
-}
-{% endif %}
-
-/* -- hyperlink styles ------------------------------------------------------ */
+/* -- body styles ----------------------------------------------------------- */
a {
color: {{ theme_linkcolor }};
text-decoration: none;
}
-a:visited {
- color: {{ theme_visitedlinkcolor }};
- text-decoration: none;
-}
-
a:hover {
text-decoration: underline;
}
-{% if theme_externalrefs|tobool %}
-a.external {
- text-decoration: none;
- border-bottom: 1px dashed {{ theme_linkcolor }};
-}
-
-a.external:hover {
- text-decoration: none;
- border-bottom: none;
-}
-
-a.external:visited {
- text-decoration: none;
- border-bottom: 1px dashed {{ theme_visitedlinkcolor }};
+div.body p, div.body dd, div.body li {
+ text-align: justify;
+ line-height: 130%;
}
-{% endif %}
-
-/* -- body styles ----------------------------------------------------------- */
div.body h1,
div.body h2,
@@ -232,18 +199,6 @@ 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;
@@ -287,10 +242,6 @@ tt {
font-size: 0.95em;
}
-th {
- background-color: #ede;
-}
-
.warning tt {
background: #efc2c2;
}
@@ -298,13 +249,3 @@ th {
.note tt {
background: #d6d6d6;
}
-
-.viewcode-back {
- font-family: {{ theme_bodyfont }};
-}
-
-div.viewcode-block:target {
- background-color: #f4debf;
- border-top: 1px solid #ac9;
- border-bottom: 1px solid #ac9;
-}
View
59 docs/build/html/_static/doctools.js
@@ -1,31 +1,16 @@
-/*
- * doctools.js
- * ~~~~~~~~~~~
- *
- * Sphinx JavaScript utilities 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();
+/// XXX: make it cross browser
/**
* 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"];
+ 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() {};
+ window.console[names[i]] = function() {}
}
- */
/**
* small helper function to urldecode strings
@@ -59,7 +44,7 @@ jQuery.getQueryParameters = function(s) {
result[key] = [value];
}
return result;
-};
+}
/**
* small function to check if an array contains
@@ -71,7 +56,7 @@ jQuery.contains = function(arr, item) {
return true;
}
return false;
-};
+}
/**
* highlight a given string on a jquery object by wrapping it in
@@ -82,7 +67,7 @@ jQuery.fn.highlightText = function(text, className) {
if (node.nodeType == 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
- if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
+ if (pos >= 0 && !jQuery.className.has(node.parentNode, className)) {
var span = document.createElement("span");
span.className = className;
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
@@ -94,14 +79,14 @@ jQuery.fn.highlightText = function(text, className) {
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
- highlight(this);
+ highlight(this)
});
}
}
return this.each(function() {
highlight(this);
});
-};
+}
/**
* Small JavaScript module for the documentation.
@@ -111,7 +96,7 @@ var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
- this.initIndexTable();
+ this.initModIndex();
},
/**
@@ -122,7 +107,7 @@ var Documentation = {
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
- // can safely bound to a different name (_ = Documentation.gettext)
+ // can savely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated == 'undefined')
@@ -182,29 +167,29 @@ var Documentation = {
var body = $('div.body');
window.setTimeout(function() {
$.each(terms, function() {
- body.highlightText(this.toLowerCase(), 'highlighted');
+ body.highlightText(this.toLowerCase(), 'highlight');
});
}, 10);
- $('<p class="highlight-link"><a href="javascript:Documentation.' +
- 'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
- .appendTo($('#searchbox'));
+ $('<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
+ * init the modindex toggle buttons
*/
- initIndexTable : function() {
+ initModIndex : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
- $('tr.cg-' + idnum).toggle();
+ console.log($('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) {
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX) {
togglers.click();
}
},
@@ -213,8 +198,8 @@ var Documentation = {
* helper function to hide the search marks again
*/
hideSearchWords : function() {
- $('#searchbox .highlight-link').fadeOut(300);
- $('span.highlighted').removeClass('highlighted');
+ $('.sidebar .this-page-menu li.highlight-link').fadeOut(300);
+ $('span.highlight').removeClass('highlight');
},
/**
View
4,520 docs/build/html/_static/jquery.js
4,371 additions, 149 deletions not shown
View
123 docs/build/html/_static/pygments.css
@@ -1,62 +1,61 @@
-.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 */
+.hll { background-color: #ffffcc }
+.c { color: #408090; font-style: italic } /* Comment */
+.err { border: 1px solid #FF0000 } /* Error */
+.k { color: #007020; font-weight: bold } /* Keyword */
+.o { color: #666666 } /* Operator */
+.cm { color: #408090; font-style: italic } /* Comment.Multiline */
+.cp { color: #007020 } /* Comment.Preproc */
+.c1 { color: #408090; font-style: italic } /* Comment.Single */
+.cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
+.gd { color: #A00000 } /* Generic.Deleted */
+.ge { font-style: italic } /* Generic.Emph */
+.gr { color: #FF0000 } /* Generic.Error */
+.gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.gi { color: #00A000 } /* Generic.Inserted */
+.go { color: #303030 } /* Generic.Output */
+.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
+.gs { font-weight: bold } /* Generic.Strong */
+.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.gt { color: #0040D0 } /* Generic.Traceback */
+.kc { color: #007020; font-weight: bold } /* Keyword.Constant */
+.kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
+.kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
+.kp { color: #007020 } /* Keyword.Pseudo */
+.kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
+.kt { color: #902000 } /* Keyword.Type */
+.m { color: #208050 } /* Literal.Number */
+.s { color: #4070a0 } /* Literal.String */
+.na { color: #4070a0 } /* Name.Attribute */
+.nb { color: #007020 } /* Name.Builtin */
+.nc { color: #0e84b5; font-weight: bold } /* Name.Class */
+.no { color: #60add5 } /* Name.Constant */
+.nd { color: #555555; font-weight: bold } /* Name.Decorator */
+.ni { color: #d55537; font-weight: bold } /* Name.Entity */
+.ne { color: #007020 } /* Name.Exception */
+.nf { color: #06287e } /* Name.Function */
+.nl { color: #002070; font-weight: bold } /* Name.Label */
+.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
+.nt { color: #062873; font-weight: bold } /* Name.Tag */
+.nv { color: #bb60d5 } /* Name.Variable */
+.ow { color: #007020; font-weight: bold } /* Operator.Word */
+.w { color: #bbbbbb } /* Text.Whitespace */
+.mf { color: #208050 } /* Literal.Number.Float */
+.mh { color: #208050 } /* Literal.Number.Hex */
+.mi { color: #208050 } /* Literal.Number.Integer */
+.mo { color: #208050 } /* Literal.Number.Oct */
+.sb { color: #4070a0 } /* Literal.String.Backtick */
+.sc { color: #4070a0 } /* Literal.String.Char */
+.sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
+.s2 { color: #4070a0 } /* Literal.String.Double */
+.se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
+.sh { color: #4070a0 } /* Literal.String.Heredoc */
+.si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
+.sx { color: #c65d09 } /* Literal.String.Other */
+.sr { color: #235388 } /* Literal.String.Regex */
+.s1 { color: #4070a0 } /* Literal.String.Single */
+.ss { color: #517918 } /* Literal.String.Symbol */
+.bp { color: #007020 } /* Name.Builtin.Pseudo */
+.vc { color: #bb60d5 } /* Name.Variable.Class */
+.vg { color: #bb60d5 } /* Name.Variable.Global */
+.vi { color: #bb60d5 } /* Name.Variable.Instance */
+.il { color: #208050 } /* Literal.Number.Integer.Long */
View
371 docs/build/html/_static/searchtools.js
@@ -1,14 +1,3 @@
-/*
- * searchtools.js_t
- * ~~~~~~~~~~~~~~~~
- *
- * 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
@@ -31,12 +20,193 @@ jQuery.makeSearchSummary = function(text, keywords, hlwords) {
((start + 240 - text.length) ? '...' : '');
var rv = $('<div class="context"></div>').text(excerpt);
$.each(hlwords, function() {
- rv = rv.highlightText(this, 'highlighted');
+ rv = rv.highlightText(this, 'highlight');
});
return rv;
}
-{{ search_language_stemming_code|safe }}
+/**
+ * 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
@@ -56,11 +226,9 @@ var Search = {
}
},
- loadIndex : function(url) {
- $.ajax({type: "GET", url: url, data: null, success: null,
- dataType: "script", cache: true});
- },
-
+ /**
+ * Sets the index
+ */
setIndex : function(index) {
var q;
this._index = index;
@@ -119,25 +287,15 @@ var Search = {
},
query : function(query) {
- var stopwords = {{ search_language_stop_words }};
-
- // Stem the searchterms and add them to the correct list
- var stemmer = new Stemmer();
+ // 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 objectterms = [];
+ var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null;
for (var i = 0; i < tmp.length; i++) {
- if (tmp[i] != "") {
- objectterms.push(tmp[i].toLowerCase());
- }
-
- 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
@@ -155,37 +313,50 @@ var Search = {
};
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
- // console.debug('SEARCH: searching for:');
- // console.info('required: ', searchterms);
- // console.info('excluded: ', excluded);
+ 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 descrefs = this._index.descrefs;
+ var modules = this._index.modules;
+ var desctypes = this._index.desctypes;
var fileMap = {};
var files = null;
- // different result priorities
- var importantResults = [];
var objectResults = [];
var regularResults = [];
- var unimportantResults = [];
$('#search-progress').empty();
// lookup as object
- for (var i = 0; i < objectterms.length; i++) {
- var others = [].concat(objectterms.slice(0,i),
- objectterms.slice(i+1, objectterms.length))
- var results = this.performObjectSearch(objectterms[i], others);
- // Assume first word is most likely to be the object,
- // other words more likely to be in description.
- // Therefore put matches for earlier words first.
- // (Results are eventually used in reverse order).
- objectResults = results[0].concat(objectResults);
- importantResults = results[1].concat(importantResults);
- unimportantResults = results[2].concat(unimportantResults);
+ if (object != null) {
+ for (var module in modules) {
+ if (module.indexOf(object) > -1) {
+ fn = modules[module];
+ descr = _('module, in ') + titles[fn];
+ objectResults.push([filenames[fn], module, '#module-'+module, descr]);
+ }
+ }
+ for (var prefix in descrefs) {
+ for (var name in descrefs[prefix]) {
+ var fullname = (prefix ? prefix + '.' : '') + name;
+ if (fullname.toLowerCase().indexOf(object) > -1) {
+ match = descrefs[prefix][name];
+ descr = desctypes[match[1]] + _(', in ') + titles[match[0]];
+ objectResults.push([filenames[match[0]], fullname, '#'+fullname, descr]);
+ }
+ }
+ }
}
+ // sort results descending
+ objectResults.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];
@@ -240,9 +411,8 @@ var Search = {
return (left > right) ? -1 : ((left < right) ? 1 : 0);
});
- // combine all results
- var results = unimportantResults.concat(regularResults)
- .concat(objectResults).concat(importantResults);
+ // combine both
+ var results = regularResults.concat(objectResults);
// print the results
var resultCount = results.length;
@@ -251,23 +421,10 @@ var Search = {
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]));
- }
+ 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);
@@ -275,16 +432,13 @@ var Search = {
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);
- }
+ $.get('_sources/' + item[0] + '.txt', function(data) {
+ listItem.append($.makeSearchSummary(data, searchterms, hlterms));
+ Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
- }, "text");
+ });
} else {
// no source available, just display title
Search.output.append(listItem);
@@ -305,71 +459,6 @@ var Search = {
}
}
displayNextItem();
- },
-
- performObjectSearch : function(object, otherterms) {
- var filenames = this._index.filenames;
- var objects = this._index.objects;
- var objnames = this._index.objnames;
- var titles = this._index.titles;
-
- var importantResults = [];
- var objectResults = [];
- var unimportantResults = [];
-
- for (var prefix in objects) {
- for (var name in objects[prefix]) {
- var fullname = (prefix ? prefix + '.' : '') + name;
- if (fullname.toLowerCase().indexOf(object) > -1) {
- var match = objects[prefix][name];
- var objname = objnames[match[1]][2];
- var title = titles[match[0]];
- // If more than one term searched for, we require other words to be
- // found in the name/title/description
- if (otherterms.length > 0) {
- var haystack = (prefix + ' ' + name + ' ' +
- objname + ' ' + title).toLowerCase();
- var allfound = true;
- for (var i = 0; i < otherterms.length; i++) {
- if (haystack.indexOf(otherterms[i]) == -1) {
- allfound = false;
- break;
- }
- }
- if (!allfound) {
- continue;
- }
- }
- var descr = objname + _(', in ') + title;
- anchor = match[3];
- if (anchor == '')
- anchor = fullname;
- else if (anchor == '-')
- anchor = objnames[match[1]][1] + '-' + fullname;
- result = [filenames[match[0]], fullname, '#'+anchor, 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);
- });
-
- return [importantResults, objectResults, unimportantResults]
}
}
View
188 docs/build/html/compilation.html
@@ -1,48 +1,152 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>
+ Compilation
+ &mdash; orbited2 v0.2.0 documentation</title>
+
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="_static/docs.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '#',
+ VERSION: '0.2.0',
+ COLLAPSE_MODINDEX: false,
+ FILE_SUFFIX: '.html'
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="_static/init.js"></script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="top" title="orbited2 v0.2.0 documentation" href="index.html" />
+ <link rel="prev" title="Deployment" href="deployment.html" />
+
-<html>
-<head>
- <title>Mako Runtime Error</title>
- <style>
- body { font-family:verdana; margin:10px 30px 10px 30px;}
- .stacktrace { margin:5px 5px 5px 5px; }
- .highlight { padding:0px 10px 0px 10px; background-color:#9F9FDF; }
- .nonhighlight { padding:0px; background-color:#DFDFDF; }
- .sample { padding:10px; margin:10px 10px 10px 10px; font-family:monospace; }
- .sampleline { padding:0px 10px 0px 10px; }
- .sourceline { margin:5px 5px 10px 5px; font-family:monospace;}
- .location { font-size:80%; }
- </style>
-</head>
-<body>
-
-<h2>Error !</h2>
-
-<h3>TypeError: 'Undefined' object is not callable</h3>
-
- <div class="sample">
- <div class="nonhighlight">
-<div class="sampleline">20 % if hasdoc(&#39;about&#39;):</div>
-<div class="sampleline">21 &lt;link rel=&#34;author&#34; title=&#34;${_(&#39;About these documents&#39;)}&#34; href=&#34;${pathto(&#39;about&#39;)}&#34; /&gt;</div>
-<div class="sampleline">22 % endif</div>
-<div class="highlight">23 &lt;link rel=&#34;index&#34; title=&#34;${_(&#39;Index&#39;)}&#34; href=&#34;${pathto(&#39;genindex&#39;)}&#34; /&gt;</div>
-<div class="sampleline">24 &lt;link rel=&#34;search&#34; title=&#34;${_(&#39;Search&#39;)}&#34; href=&#34;${pathto(&#39;search&#39;)}&#34; /&gt;</div>
-<div class="sampleline">25 % if hasdoc(&#39;copyright&#39;):</div>
-<div class="sampleline">26 &lt;link rel=&#34;copyright&#34; title=&#34;${_(&#39;Copyright&#39;)}&#34; href=&#34;${pathto(&#39;copyright&#39;)}&#34; /&gt;</div>
-<div class="sampleline">27 % endif</div>
-<div class="sampleline">28 &lt;link rel=&#34;top&#34; title=&#34;${docstitle|h}&#34; href=&#34;${pathto(&#39;index&#39;)}&#34; /&gt;</div>
- </div>
- </div>
-
-<div class="stacktrace">
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/layout.mako, line 23:</div>
- <div class="sourceline"> &lt;link rel=&#34;index&#34; title=&#34;${_(&#39;Index&#39;)}&#34; href=&#34;${pathto(&#39;genindex&#39;)}&#34; /&gt;</div>
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/static_base.mako, line 9:</div>
- <div class="sourceline"> ${self.headers()}</div>
- <div class="location">/Library/Python/2.7/site-packages/Mako-0.5.0-py2.7.egg/mako/runtime.py, line 711:</div>
- <div class="sourceline">callable_(context, *args, **kwargs)</div>
+ </head>
+ <body>
+
+
+
+
+
+ <h1>orbited2 v0.2.0 documentation</h1>
+
+ <div id="search">
+ Search:
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+
+ <div class="versionheader">
+ Version: <span class="versionnum">0.2.0</span> Last Updated: None
+ </div>
+ <div class="clearboth"></div>
+
+ <div class="topnav">
+ <div id="pagecontrol">
+ <a href="reference/index.html">API Reference</a>
+ |
+ <a href="genindex.html">Index</a>
+
+ <div class="sourcelink">(<a href="_sources/compilation.txt">view source)</div>
+ </div>
+
+ <div class="navbanner">
+ <a class="totoc" href="index.html">Table of Contents</a>
+ »
+ Compilation
+
+
+
+<div class="prevnext">
+ Previous:
+ <a href="deployment.html" title="previous chapter">Deployment</a>
</div>
-</body>
+ <h2>
+
+ Compilation
+
+ </h2>
+ </div>
+ <ul>
+<li><a class="reference external" href="#">Compilation</a><ul>
+<li><a class="reference external" href="#instructions">Instructions</a></li>
+</ul>
+</li>
+</ul>
+
+ <div class="clearboth"></div>
+ </div>
+
+ <div class="document">
+ <div class="body">
+
+<div class="section" id="compilation">
+<h1>Compilation<a class="headerlink" href="#compilation" title="Permalink to this headline">¶</a></h1>
+<p>Curious users may wish to modify the source code and recompile Orbited2. Here&#8217;s how, courtesy of Niklas.</p>
+<div class="section" id="instructions">
+<h2>Instructions<a class="headerlink" href="#instructions" title="Permalink to this headline">¶</a></h2>
+<ol class="arabic simple">
+<li>Check-out js.io from github (<a class="reference external" href="https://github.com/gameclosure/js.io">https://github.com/gameclosure/js.io</a>)</li>
+<li>Make a symlink from js.io/jsio to /usr/bin/jsio (for easier use)</li>
+<li>Enter daemon/orbited/js_src and make sure your orbited.pkg looks something like this:</li>
+</ol>
+<div class="highlight-none"><div class="highlight"><pre>{
+ &quot;root&quot;: &quot;./Orbited2&quot;,
+ &quot;externalName&quot;: &quot;Orbited2&quot;,
+ &quot;transports&quot;: [&quot;csp&quot;, &quot;websocket&quot;],
+ &quot;environments&quot;: [&quot;browser&quot;],
+ &quot;additional_dependancies&quot;: [ ]
+}</pre></div>
+</div>
+<ol class="arabic simple" start="4">
+<li>Compile the source (while in js_src) with:</li>
+</ol>
+<div class="highlight-none"><div class="highlight"><pre>jsio compile Orbited2.pkg -o Orbited2-new.js</pre></div>
+</div>
+<ol class="arabic simple" start="5">
+<li>You&#8217;re done. Celebrate!</li>
+</ol>
+</div>
+</div>
+
+ </div>
+ </div>
+
+
+
+ <div class="bottomnav">
+
+<div class="prevnext">
+ Previous:
+ <a href="deployment.html" title="previous chapter">Deployment</a>
+</div>
+
+ <div class="doc_copyright">
+ &copy; Copyright 2010, Michael Carter.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
+ </div>
+ </div>
+
+
+
+
+
+
+
+ </body>
</html>
+
+
+
View
255 docs/build/html/configuration.html
@@ -1,48 +1,215 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>
+ Configuration
+ &mdash; orbited2 v0.2.0 documentation</title>
+
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="_static/docs.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '#',
+ VERSION: '0.2.0',
+ COLLAPSE_MODINDEX: false,
+ FILE_SUFFIX: '.html'
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="_static/init.js"></script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="top" title="orbited2 v0.2.0 documentation" href="index.html" />
+ <link rel="next" title="&lt;no title&gt;" href="websocket.html" />
+ <link rel="prev" title="Introduction" href="intro.html" />
+
-<html>
-<head>
- <title>Mako Runtime Error</title>
- <style>
- body { font-family:verdana; margin:10px 30px 10px 30px;}
- .stacktrace { margin:5px 5px 5px 5px; }
- .highlight { padding:0px 10px 0px 10px; background-color:#9F9FDF; }
- .nonhighlight { padding:0px; background-color:#DFDFDF; }
- .sample { padding:10px; margin:10px 10px 10px 10px; font-family:monospace; }
- .sampleline { padding:0px 10px 0px 10px; }
- .sourceline { margin:5px 5px 10px 5px; font-family:monospace;}
- .location { font-size:80%; }
- </style>
-</head>
-<body>
-
-<h2>Error !</h2>
-
-<h3>TypeError: 'Undefined' object is not callable</h3>
-
- <div class="sample">
- <div class="nonhighlight">
-<div class="sampleline">20 % if hasdoc(&#39;about&#39;):</div>
-<div class="sampleline">21 &lt;link rel=&#34;author&#34; title=&#34;${_(&#39;About these documents&#39;)}&#34; href=&#34;${pathto(&#39;about&#39;)}&#34; /&gt;</div>
-<div class="sampleline">22 % endif</div>
-<div class="highlight">23 &lt;link rel=&#34;index&#34; title=&#34;${_(&#39;Index&#39;)}&#34; href=&#34;${pathto(&#39;genindex&#39;)}&#34; /&gt;</div>
-<div class="sampleline">24 &lt;link rel=&#34;search&#34; title=&#34;${_(&#39;Search&#39;)}&#34; href=&#34;${pathto(&#39;search&#39;)}&#34; /&gt;</div>
-<div class="sampleline">25 % if hasdoc(&#39;copyright&#39;):</div>
-<div class="sampleline">26 &lt;link rel=&#34;copyright&#34; title=&#34;${_(&#39;Copyright&#39;)}&#34; href=&#34;${pathto(&#39;copyright&#39;)}&#34; /&gt;</div>
-<div class="sampleline">27 % endif</div>
-<div class="sampleline">28 &lt;link rel=&#34;top&#34; title=&#34;${docstitle|h}&#34; href=&#34;${pathto(&#39;index&#39;)}&#34; /&gt;</div>
- </div>
- </div>
-
-<div class="stacktrace">
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/layout.mako, line 23:</div>
- <div class="sourceline"> &lt;link rel=&#34;index&#34; title=&#34;${_(&#39;Index&#39;)}&#34; href=&#34;${pathto(&#39;genindex&#39;)}&#34; /&gt;</div>
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/static_base.mako, line 9:</div>
- <div class="sourceline"> ${self.headers()}</div>
- <div class="location">/Library/Python/2.7/site-packages/Mako-0.5.0-py2.7.egg/mako/runtime.py, line 711:</div>
- <div class="sourceline">callable_(context, *args, **kwargs)</div>
-</div>
-
-</body>
+ </head>
+ <body>
+
+
+
+
+
+ <h1>orbited2 v0.2.0 documentation</h1>
+
+ <div id="search">
+ Search:
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+
+ <div class="versionheader">
+ Version: <span class="versionnum">0.2.0</span> Last Updated: None
+ </div>
+ <div class="clearboth"></div>
+
+ <div class="topnav">
+ <div id="pagecontrol">
+ <a href="reference/index.html">API Reference</a>
+ |
+ <a href="genindex.html">Index</a>
+
+ <div class="sourcelink">(<a href="_sources/configuration.txt">view source)</div>
+ </div>
+
+ <div class="navbanner">
+ <a class="totoc" href="index.html">Table of Contents</a>
+ »
+ Configuration
+
+
+
+<div class="prevnext">
+ Previous:
+ <a href="intro.html" title="previous chapter">Introduction</a>
+ Next:
+ <a href="websocket.html" title="next chapter">&lt;no title&gt;</a>
+</div>
+
+ <h2>
+
+ Configuration
+
+ </h2>
+ </div>
+ <ul>
+<li><a class="reference external" href="#">Configuration</a><ul>
+<li><a class="reference external" href="#overview">Overview</a></li>
+<li><a class="reference external" href="#remotedestination">RemoteDestination</a><ul>
+<li><a class="reference external" href="#name-required">name (required)</a></li>
+<li><a class="reference external" href="#hostname-required">hostname (required)</a></li>
+<li><a class="reference external" href="#port-required">port (required)</a></li>
+<li><a class="reference external" href="#host-header-required">host_header (required)</a></li>
+<li><a class="reference external" href="#protocol">protocol</a></li>
+</ul>
+</li>
+<li><a class="reference external" href="#listen">Listen</a><ul>
+<li><a class="reference external" href="#interface-required">interface (required)</a></li>
+<li><a class="reference external" href="#id1">port (required)</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+ <div class="clearboth"></div>
+ </div>
+
+ <div class="document">
+ <div class="body">
+
+<div class="section" id="configuration">
+<h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1>
+<p>Orbited2 takes a single command line argument, -c (or &#8211;config) and the file location of your config file. The default is orbited2.cfg. This config file has two directives.</p>
+<div class="section" id="overview">
+<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
+<p>A user would run:</p>
+<div class="highlight-none"><div class="highlight"><pre>user@host:~# orbited2 --config /etc/orbited2.cfg</pre></div>
+</div>
+<p>A configuration example:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="c"># Contents of /etc/orbited2.cfg</span>
+
+<span class="c"># Access Control</span>
+
+<span class="n">RemoteDestination</span><span class="p">(</span>
+ <span class="n">name</span><span class="o">=</span><span class="s">&quot;ws_echo&quot;</span><span class="p">,</span> <span class="c"># for logging purposes</span>
+ <span class="n">hostname</span><span class="o">=</span><span class="s">&quot;127.0.0.1&quot;</span><span class="p">,</span>
+ <span class="n">port</span><span class="o">=</span><span class="mi">8083</span><span class="p">,</span>
+ <span class="n">host_header</span> <span class="o">=</span> <span class="s">&#39;*&#39;</span><span class="p">,</span> <span class="c"># let any scripts from anywhere access this remote destination</span>
+ <span class="n">protocol</span><span class="o">=</span><span class="s">&quot;ws/hixie76&quot;</span> <span class="c"># normalize outgoing connections to WebSocket draft 76</span>
+<span class="p">)</span>
+
+<span class="c"># Listen</span>
+
+<span class="n">Listen</span> <span class="p">(</span>
+ <span class="n">port</span><span class="o">=</span><span class="mi">8000</span><span class="p">,</span>
+ <span class="n">interface</span><span class="o">=</span><span class="s">&quot;0.0.0.0&quot;</span> <span class="c"># bind to all ports</span>
+<span class="p">)</span></pre></div>
+</div>
+</div>
+<div class="section" id="remotedestination">
+<h2>RemoteDestination<a class="headerlink" href="#remotedestination" title="Permalink to this headline">¶</a></h2>
+<p>The RemoteDestination directive specifies a remote server that Orbited2 will proxy to. If a webpage tries to use Orbited2 to open a connection to a remote destination that has no corresponding RemoteDestination directive, the connection will be denied. You may have as many remote destinations as you like, so long as they are each given a unique name.</p>
+<div class="section" id="name-required">
+<h3>name (required)<a class="headerlink" href="#name-required" title="Permalink to this headline">¶</a></h3>
+<p>Unique name for logging purposes</p>
+</div>
+<div class="section" id="hostname-required">
+<h3>hostname (required)<a class="headerlink" href="#hostname-required" title="Permalink to this headline">¶</a></h3>
+<p>Destination hostname. This is a string that may represent either an ip address or a hostname.</p>
+</div>
+<div class="section" id="port-required">
+<h3>port (required)<a class="headerlink" href="#port-required" title="Permalink to this headline">¶</a></h3>
+<p>Destination port; an integer.</p>
+</div>
+<div class="section" id="host-header-required">
+<h3>host_header (required)<a class="headerlink" href="#host-header-required" title="Permalink to this headline">¶</a></h3>
+<p>All connections to this remote destination via orbited will only be authorized if the &#8220;Host&#8221; header in the initial HTTP request matches the value of this rule. This value should just be the domain name of your website, in most cases. For testing purposes you may put a &#8216;*&#8217; here.</p>
+</div>
+<div class="section" id="protocol">
+<h3>protocol<a class="headerlink" href="#protocol" title="Permalink to this headline">¶</a></h3>
+<p>The outgoing protocol. The default is &#8220;ws/hixie76&#8221;. Valid options are: &#8220;tcp&#8221;, &#8220;ws/hixie75&#8221;, and &#8220;ws/hixie76&#8221;. We will support new versions of the WebSocket protocol as they are released.</p>
+<p>If you are using the Orbited.TCPSocket javascript api, then the value of protocol must be &#8216;tcp&#8217;.</p>
+<p>If you are using the Orbited.WebSocket.install javascript api, the <cite>protocolVersion</cite> value given there should match the revision number given here.</p>
+</div>
+</div>
+<div class="section" id="listen">
+<h2>Listen<a class="headerlink" href="#listen" title="Permalink to this headline">¶</a></h2>
+<p>The Listen directive specifies an interface and port where Orbited2 should listen, as well as a set of protocols it should listen for. You may have as many Listen directives as you like. An example</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">Listen</span> <span class="p">(</span>
+ <span class="n">port</span><span class="o">=</span><span class="mi">8000</span><span class="p">,</span>
+ <span class="n">interface</span><span class="o">=</span><span class="s">&quot;0.0.0.0&quot;</span>
+<span class="p">)</span></pre></div>
+</div>
+<div class="section" id="interface-required">
+<h3>interface (required)<a class="headerlink" href="#interface-required" title="Permalink to this headline">¶</a></h3>
+<p>A string representing the interface that hookbox should bind to.</p>
+</div>
+<div class="section" id="id1">
+<h3>port (required)<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
+<p>An integer specifying the port that hookbox should bind to.</p>
+</div>
+</div>
+</div>
+
+ </div>
+ </div>
+
+
+
+ <div class="bottomnav">
+
+<div class="prevnext">
+ Previous:
+ <a href="intro.html" title="previous chapter">Introduction</a>
+ Next:
+ <a href="websocket.html" title="next chapter">&lt;no title&gt;</a>
+</div>
+
+ <div class="doc_copyright">
+ &copy; Copyright 2010, Michael Carter.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
+ </div>
+ </div>
+
+
+
+
+
+
+
+ </body>
</html>
+
+
+
View
164 docs/build/html/deployment.html
@@ -1,48 +1,128 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>
+ Deployment
+ &mdash; orbited2 v0.2.0 documentation</title>
+
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="_static/docs.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '#',
+ VERSION: '0.2.0',
+ COLLAPSE_MODINDEX: false,
+ FILE_SUFFIX: '.html'
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="_static/init.js"></script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="top" title="orbited2 v0.2.0 documentation" href="index.html" />
+ <link rel="next" title="Compilation" href="compilation.html" />
+ <link rel="prev" title="&lt;no title&gt;" href="under_the_hood.html" />
+
-<html>
-<head>
- <title>Mako Runtime Error</title>
- <style>
- body { font-family:verdana; margin:10px 30px 10px 30px;}
- .stacktrace { margin:5px 5px 5px 5px; }
- .highlight { padding:0px 10px 0px 10px; background-color:#9F9FDF; }
- .nonhighlight { padding:0px; background-color:#DFDFDF; }
- .sample { padding:10px; margin:10px 10px 10px 10px; font-family:monospace; }
- .sampleline { padding:0px 10px 0px 10px; }
- .sourceline { margin:5px 5px 10px 5px; font-family:monospace;}
- .location { font-size:80%; }
- </style>
-</head>
-<body>
-
-<h2>Error !</h2>
-
-<h3>TypeError: 'Undefined' object is not callable</h3>
-
- <div class="sample">
- <div class="nonhighlight">
-<div class="sampleline">20 % if hasdoc(&#39;about&#39;):</div>
-<div class="sampleline">21 &lt;link rel=&#34;author&#34; title=&#34;${_(&#39;About these documents&#39;)}&#34; href=&#34;${pathto(&#39;about&#39;)}&#34; /&gt;</div>
-<div class="sampleline">22 % endif</div>
-<div class="highlight">23 &lt;link rel=&#34;index&#34; title=&#34;${_(&#39;Index&#39;)}&#34; href=&#34;${pathto(&#39;genindex&#39;)}&#34; /&gt;</div>
-<div class="sampleline">24 &lt;link rel=&#34;search&#34; title=&#34;${_(&#39;Search&#39;)}&#34; href=&#34;${pathto(&#39;search&#39;)}&#34; /&gt;</div>
-<div class="sampleline">25 % if hasdoc(&#39;copyright&#39;):</div>
-<div class="sampleline">26 &lt;link rel=&#34;copyright&#34; title=&#34;${_(&#39;Copyright&#39;)}&#34; href=&#34;${pathto(&#39;copyright&#39;)}&#34; /&gt;</div>
-<div class="sampleline">27 % endif</div>
-<div class="sampleline">28 &lt;link rel=&#34;top&#34; title=&#34;${docstitle|h}&#34; href=&#34;${pathto(&#39;index&#39;)}&#34; /&gt;</div>
- </div>
- </div>
-
-<div class="stacktrace">
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/layout.mako, line 23:</div>
- <div class="sourceline"> &lt;link rel=&#34;index&#34; title=&#34;${_(&#39;Index&#39;)}&#34; href=&#34;${pathto(&#39;genindex&#39;)}&#34; /&gt;</div>
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/static_base.mako, line 9:</div>
- <div class="sourceline"> ${self.headers()}</div>
- <div class="location">/Library/Python/2.7/site-packages/Mako-0.5.0-py2.7.egg/mako/runtime.py, line 711:</div>
- <div class="sourceline">callable_(context, *args, **kwargs)</div>
+ </head>
+ <body>
+
+
+
+
+
+ <h1>orbited2 v0.2.0 documentation</h1>
+
+ <div id="search">
+ Search:
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+
+ <div class="versionheader">
+ Version: <span class="versionnum">0.2.0</span> Last Updated: None
+ </div>
+ <div class="clearboth"></div>
+
+ <div class="topnav">
+ <div id="pagecontrol">
+ <a href="reference/index.html">API Reference</a>
+ |
+ <a href="genindex.html">Index</a>
+
+ <div class="sourcelink">(<a href="_sources/deployment.txt">view source)</div>
+ </div>
+
+ <div class="navbanner">
+ <a class="totoc" href="index.html">Table of Contents</a>
+ »
+ Deployment
+
+
+
+<div class="prevnext">
+ Previous:
+ <a href="under_the_hood.html" title="previous chapter">&lt;no title&gt;</a>
+ Next:
+ <a href="compilation.html" title="next chapter">Compilation</a>
+</div>
+
+ <h2>
+
+ Deployment
+
+ </h2>
+ </div>
+ <div class="clearboth"></div>
+ </div>
+
+ <div class="document">
+ <div class="body">
+
+<div class="section" id="deployment">
+<h1>Deployment<a class="headerlink" href="#deployment" title="Permalink to this headline">¶</a></h1>
+<p>Orbited2 takes a single command line argument, -c (or &#8211;config) and the file location of your config file. The default is orbited2.cfg. Thus, deployment consists of creating a suitable orbited2.cfg and typing:</p>
+<div class="highlight-none"><div class="highlight"><pre># orbited2</pre></div>
+</div>
</div>
-</body>
+ </div>
+ </div>
+
+
+
+ <div class="bottomnav">
+
+<div class="prevnext">
+ Previous:
+ <a href="under_the_hood.html" title="previous chapter">&lt;no title&gt;</a>
+ Next:
+ <a href="compilation.html" title="next chapter">Compilation</a>
+</div>
+
+ <div class="doc_copyright">
+ &copy; Copyright 2010, Michael Carter.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
+ </div>
+ </div>
+
+
+
+
+
+
+
+ </body>
</html>
+
+
+
View
152 docs/build/html/genindex.html
@@ -1,49 +1,115 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Index &mdash; orbited2 v0.2.0 documentation</title>
+
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="_static/docs.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '#',
+ VERSION: '0.2.0',
+ COLLAPSE_MODINDEX: false,
+ FILE_SUFFIX: '.html'
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="_static/init.js"></script>
+ <link rel="index" title="Index" href="#" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="top" title="orbited2 v0.2.0 documentation" href="index.html" />
+
-<html>
-<head>
- <title>Mako Runtime Error</title>
- <style>
- body { font-family:verdana; margin:10px 30px 10px 30px;}
- .stacktrace { margin:5px 5px 5px 5px; }
- .highlight { padding:0px 10px 0px 10px; background-color:#9F9FDF; }
- .nonhighlight { padding:0px; background-color:#DFDFDF; }
- .sample { padding:10px; margin:10px 10px 10px 10px; font-family:monospace; }
- .sampleline { padding:0px 10px 0px 10px; }
- .sourceline { margin:5px 5px 10px 5px; font-family:monospace;}
- .location { font-size:80%; }
- </style>
-</head>
-<body>
-
-<h2>Error !</h2>
-
-<h3>TypeError: 'Undefined' object is not callable</h3>
-
- <div class="sample">
- <div class="nonhighlight">
-<div class="sampleline">1 &lt;%inherit file=&#34;layout.mako&#34;/&gt;</div>
-<div class="sampleline">2 </div>
-<div class="highlight">3 &lt;%def name=&#34;show_title()&#34;&gt;${_(&#39;Index&#39;)}&lt;/%def&gt;</div>
-<div class="sampleline">4 </div>
-<div class="sampleline">5 &lt;h1 id=&#34;index&#34;&gt;${_(&#39;Index&#39;)}&lt;/h1&gt;</div>
-<div class="sampleline">6 </div>
-<div class="sampleline">7 % for i, (key, dummy) in enumerate(genindexentries):</div>
-<div class="sampleline">8 ${i != 0 and &#39;| &#39; or &#39;&#39;}&lt;a href=&#34;#${key}&#34;&gt;&lt;strong&gt;${key}&lt;/strong&gt;&lt;/a&gt;</div>
- </div>
- </div>
-
-<div class="stacktrace">
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/genindex.mako, line 3:</div>
- <div class="sourceline">&lt;%def name=&#34;show_title()&#34;&gt;${_(&#39;Index&#39;)}&lt;/%def&gt;</div>
- <div class="location">/Library/Python/2.7/site-packages/Mako-0.5.0-py2.7.egg/mako/runtime.py, line 552:</div>
- <div class="sourceline">callable_(*args, **kwargs)</div>
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/static_base.mako, line 8:</div>
- <div class="sourceline"> &lt;title&gt;${capture(self.show_title)|util.striptags} &amp;mdash; ${docstitle|h}&lt;/title&gt;</div>
- <div class="location">/Library/Python/2.7/site-packages/Mako-0.5.0-py2.7.egg/mako/runtime.py, line 711:</div>
- <div class="sourceline">callable_(context, *args, **kwargs)</div>
+ </head>
+ <body>
+
+
+
+
+
+ <h1>orbited2 v0.2.0 documentation</h1>
+
+ <div id="search">
+ Search:
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+
+ <div class="versionheader">
+ Version: <span class="versionnum">0.2.0</span> Last Updated: None
+ </div>
+ <div class="clearboth"></div>
+
+ <div class="topnav">
+ <div id="pagecontrol">
+ <a href="reference/index.html">API Reference</a>
+ |
+ <a href="#">Index</a>
+
+ </div>
+
+ <div class="navbanner">
+ <a class="totoc" href="index.html">Table of Contents</a>
+ » Index
+
+
+<div class="prevnext">
+</div>
+
+ <h2>
+ Index
+ </h2>
+ </div>
+ <div class="clearboth"></div>
+ </div>
+
+ <div class="document">
+ <div class="body">
+
+
+
+
+ <h1 id="index">Index</h1>
+
+
+ <hr />
+
+
+
+
+ </div>
+ </div>
+
+
+
+ <div class="bottomnav">
+
+<div class="prevnext">
</div>
-</body>
+ <div class="doc_copyright">
+ &copy; Copyright 2010, Michael Carter.
+ Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
+ </div>
+ </div>
+
+
+
+
+
+
+
+ </body>
</html>
+
+
+
View
173 docs/build/html/index.html
@@ -1,48 +1,137 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>
+ Orbited2 Documentation
+ &mdash; orbited2 v0.2.0 documentation</title>
+
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <link rel="stylesheet" href="_static/docs.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '#',
+ VERSION: '0.2.0',
+ COLLAPSE_MODINDEX: false,
+ FILE_SUFFIX: '.html'
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <script type="text/javascript" src="_static/init.js"></script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="top" title="orbited2 v0.2.0 documentation" href="#" />
+ <link rel="next" title="Introduction" href="intro.html" />
+
-<html>
-<head>
- <title>Mako Runtime Error</title>
- <style>
- body { font-family:verdana; margin:10px 30px 10px 30px;}
- .stacktrace { margin:5px 5px 5px 5px; }
- .highlight { padding:0px 10px 0px 10px; background-color:#9F9FDF; }
- .nonhighlight { padding:0px; background-color:#DFDFDF; }
- .sample { padding:10px; margin:10px 10px 10px 10px; font-family:monospace; }
- .sampleline { padding:0px 10px 0px 10px; }
- .sourceline { margin:5px 5px 10px 5px; font-family:monospace;}
- .location { font-size:80%; }
- </style>
-</head>
-<body>
-
-<h2>Error !</h2>
-
-<h3>TypeError: 'Undefined' object is not callable</h3>
-
- <div class="sample">
- <div class="nonhighlight">
-<div class="sampleline">20 % if hasdoc(&#39;about&#39;):</div>
-<div class="sampleline">21 &lt;link rel=&#34;author&#34; title=&#34;${_(&#39;About these documents&#39;)}&#34; href=&#34;${pathto(&#39;about&#39;)}&#34; /&gt;</div>
-<div class="sampleline">22 % endif</div>
-<div class="highlight">23 &lt;link rel=&#34;index&#34; title=&#34;${_(&#39;Index&#39;)}&#34; href=&#34;${pathto(&#39;genindex&#39;)}&#34; /&gt;</div>
-<div class="sampleline">24 &lt;link rel=&#34;search&#34; title=&#34;${_(&#39;Search&#39;)}&#34; href=&#34;${pathto(&#39;search&#39;)}&#34; /&gt;</div>
-<div class="sampleline">25 % if hasdoc(&#39;copyright&#39;):</div>
-<div class="sampleline">26 &lt;link rel=&#34;copyright&#34; title=&#34;${_(&#39;Copyright&#39;)}&#34; href=&#34;${pathto(&#39;copyright&#39;)}&#34; /&gt;</div>
-<div class="sampleline">27 % endif</div>
-<div class="sampleline">28 &lt;link rel=&#34;top&#34; title=&#34;${docstitle|h}&#34; href=&#34;${pathto(&#39;index&#39;)}&#34; /&gt;</div>
- </div>
- </div>
-
-<div class="stacktrace">
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/layout.mako, line 23:</div>
- <div class="sourceline"> &lt;link rel=&#34;index&#34; title=&#34;${_(&#39;Index&#39;)}&#34; href=&#34;${pathto(&#39;genindex&#39;)}&#34; /&gt;</div>
- <div class="location">/Users/gameclosure/gc/orbited2/docs/source/_templates/static_base.mako, line 9:</div>
- <div class="sourceline"> ${self.headers()}</div>
- <div class="location">/Library/Python/2.7/site-packages/Mako-0.5.0-py2.7.egg/mako/runtime.py, line 711:</div>
- <div class="sourceline">callable_(context, *args, **kwargs)</div>
+ </head>
+ <body>
+
+
+
+
+
+ <h1>orbited2 v0.2.0 documentation</h1>
+
+ <div id="search">
+ Search:
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ </div>
+
+ <div class="versionheader">