Files
Hippolyzer/docs/html/index.html
2009-10-15 21:48:05 +00:00

154 lines
6.7 KiB
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>Welcome to the pyogp.lib.base API docs &mdash; pyogp.lib.base v0.1 documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.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.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pyogp.lib.base v0.1 documentation" href="" />
<link rel="next" title="Modules" href="modules.html" />
</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 class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="modules.html" title="Modules"
accesskey="N">next</a> |</li>
<li><a href="">pyogp.lib.base v0.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="">Welcome to the pyogp.lib.base API docs</a></li>
<li><a class="reference external" href="#modules">Modules</a><ul>
</ul>
</li>
<li><a class="reference external" href="#unit-tests">Unit Tests</a><ul>
</ul>
</li>
<li><a class="reference external" href="#indices-and-tables">Indices and tables</a></li>
<li><a class="reference external" href="#history">History</a><ul>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="modules.html"
title="next chapter">Modules</a></p>
<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="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-the-pyogp-lib-base-api-docs">
<span id="contents"></span><h1>Welcome to the pyogp.lib.base API docs<a class="headerlink" href="#welcome-to-the-pyogp-lib-base-api-docs" title="Permalink to this headline"></a></h1>
<p>(doc set created October 15, 2009)</p>
<p>Pyogp is a python library for interacting with virtual world environments like Second Life. Started as a test framework for new <a class="reference external" href="http://wiki.secondlife.com/wiki/Open_Grid_Protocol">Open Grid Protocol</a> work led by Linden Lab, Pyogp continues as a client library for current and future protocols.</p>
<p>This set of documents is primarily for use as API documentation for the pyogp.lib.base package. This package contains the basic networking, messaging, datatypes, and event system modules used in establishing a client connection to a Second Life grid.</p>
<p>Other resources on the web:</p>
<ul class="simple">
<li>Project Home - <a class="reference external" href="http://wiki.secondlife.com/wiki/PyOGP">http://wiki.secondlife.com/wiki/PyOGP</a></li>
<li>User Docs - <a class="reference external" href="http://wiki.secondlife.com/wiki/PyOGP_Client_Library">http://wiki.secondlife.com/wiki/PyOGP_Client_Library</a></li>
</ul>
<p>Pyogp is still young, and constantly evolving. Help refresh these docs regularly as work continues.</p>
</div>
<div class="section" id="modules">
<h1>Modules<a class="headerlink" href="#modules" title="Permalink to this headline"></a></h1>
<p>Doc strings for all library files (modules) and their classes and methods.</p>
<ul>
<li class="toctree-l1"><a class="reference external" href="modules.html">Modules</a></li>
</ul>
</div>
<div class="section" id="unit-tests">
<h1>Unit Tests<a class="headerlink" href="#unit-tests" title="Permalink to this headline"></a></h1>
<p>Internal unit tests.</p>
<ul>
<li class="toctree-l1"><a class="reference external" href="unittest.html">Unit Tests</a></li>
</ul>
</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 external" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
<li><a class="reference external" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
<div class="section" id="history">
<h1>History<a class="headerlink" href="#history" title="Permalink to this headline"></a></h1>
<ul>
<li class="toctree-l1"><a class="reference external" href="history.html">History</a></li>
</ul>
</div>
</div>
</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 class="right" >
<a href="modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="modules.html" title="Modules"
>next</a> |</li>
<li><a href="">pyogp.lib.base v0.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Pyogp team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
</div>
</body>
</html>