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

56 lines
1.3 KiB
ReStructuredText

.. _contents:
Welcome to the pyogp.lib.base API docs
======================================
(doc set created |today|)
Pyogp is a python library for interacting with virtual world environments like Second Life. Started as a test framework for new `Open Grid Protocol <http://wiki.secondlife.com/wiki/Open_Grid_Protocol>`_ work led by Linden Lab, Pyogp continues as a client library for current and future protocols.
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.
Other resources on the web:
* Project Home - `<http://wiki.secondlife.com/wiki/PyOGP>`_
* User Docs - `<http://wiki.secondlife.com/wiki/PyOGP_Client_Library>`_
Pyogp is still young, and constantly evolving. Help refresh these docs regularly as work continues.
Modules
=======
Doc strings for all library files (modules) and their classes and methods.
.. toctree::
:maxdepth: 1
modules
Unit Tests
==========
Internal unit tests.
.. toctree::
:maxdepth: 1
unittest
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
History
=======
.. toctree::
:maxdepth: 1
history