moving sphinx docs to their natural location

docs/source/modules/caps.rst

@@ -0,0 +1,15 @@
+:mod:`caps`
+===========
+
+.. automodule:: pyogp.lib.base.caps
+
+.. autoclass:: pyogp.lib.base.caps.Capability
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.caps.SeedCapability
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/circuit.rst

@@ -0,0 +1,25 @@
+:mod:`circuit`
+==============
+
+.. automodule:: pyogp.lib.base.message.circuit
+
+.. autoclass:: pyogp.lib.base.message.circuit.CircuitManager
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.circuit.PackFlags
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.circuit.Host
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.circuit.Circuit
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/data_packer.rst

@@ -0,0 +1,20 @@
+:mod:`data_packer`
+==================
+
+.. automodule:: pyogp.lib.base.message.data_packer
+
+.. autoclass:: pyogp.lib.base.message.data_packer.MsgType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.data_packer.EndianType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.data_packer.DataPacker
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/data_unpacker.rst

@@ -0,0 +1,20 @@
+:mod:`data_unpacker`
+====================
+
+.. automodule:: pyogp.lib.base.message.data_unpacker
+
+.. autoclass:: pyogp.lib.base.message.data_unpacker.EndianType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.data_unpacker.MsgType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.data_unpacker.DataUnpacker
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/datatypes.rst

@@ -0,0 +1,20 @@
+:mod:`datatypes`
+================
+
+.. automodule:: pyogp.lib.base.datatypes
+
+.. autoclass:: pyogp.lib.base.datatypes.Quaternion
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.datatypes.Vector3
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.datatypes.UUID
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/event_queue.rst

@@ -0,0 +1,10 @@
+:mod:`event_queue`
+==================
+
+.. automodule:: pyogp.lib.base.event_queue
+
+.. autoclass:: pyogp.lib.base.event_queue.EventQueueClient
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/events.rst

@@ -0,0 +1,10 @@
+:mod:`events`
+=============
+
+.. automodule:: pyogp.lib.base.events
+
+.. autoclass:: pyogp.lib.base.events.Event
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/exc.rst

@@ -0,0 +1,165 @@
+:mod:`exc`
+==========
+
+.. automodule:: pyogp.lib.base.exc
+
+.. autoclass:: pyogp.lib.base.exc.MessageDeserializationError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.AgentDomainError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.UserNotFound
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.ResourceNotFound
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.DataParsingError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.AgentError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.MessageSerializationError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.DeserializationError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.RegionSeedCapNotAvailable
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.RegionCapNotAvailable
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.MessageTemplateParsingError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.UserNotAuthorized
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.DataUnpackingError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.CircuitNotFound
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.ResourceError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.CredentialDeserializerNotFound
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.NotImplemented
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.MessageSystemError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.DeserializerNotFound
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.LoginError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.SerializationError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.ParseStartLocError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.RegionDomainError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.Error
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.HTTPError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.DeserializationFailed
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.RegionMessageError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.Deprecated
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.UserRezFailed
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.MessageTemplateNotFound
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.NetworkError
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.exc.MessageBuildingError
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/factory.rst

@@ -0,0 +1,10 @@
+:mod:`factory`
+==============
+
+.. automodule:: pyogp.lib.base.message.factory
+
+.. autoclass:: pyogp.lib.base.message.factory.MessageFactory
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/helpers.rst

@@ -0,0 +1,30 @@
+:mod:`helpers`
+==============
+
+.. automodule:: pyogp.lib.base.helpers
+
+.. autoclass:: pyogp.lib.base.helpers.LLSDDeserializer
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.helpers.ListLLSDSerializer
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.helpers.Helpers
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.helpers.DictLLSDSerializer
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.helpers.Wait
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/llsd_builder.rst

@@ -0,0 +1,25 @@
+:mod:`llsd_builder`
+===================
+
+.. automodule:: pyogp.lib.base.message.llsd_builder
+
+.. autoclass:: pyogp.lib.base.message.llsd_builder.MsgData
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.llsd_builder.MsgVariableData
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.llsd_builder.MsgBlockData
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.llsd_builder.LLSDMessageBuilder
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/llsd_sender.rst

@@ -0,0 +1,5 @@
+:mod:`llsd_sender`
+==================
+
+.. automodule:: pyogp.lib.base.message.llsd_sender
+

docs/source/modules/message.rst

@@ -0,0 +1,45 @@
+:mod:`message`
+==============
+
+.. automodule:: pyogp.lib.base.message.message
+
+.. autoclass:: pyogp.lib.base.message.message.Block
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.message.PackFlags
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.message.MsgData
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.message.MessageBase
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.message.Variable
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.message.Message
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.message.MsgVariableData
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.message.MsgBlockData
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/message_dot_xml.rst

@@ -0,0 +1,10 @@
+:mod:`message_dot_xml`
+======================
+
+.. automodule:: pyogp.lib.base.message.message_dot_xml
+
+.. autoclass:: pyogp.lib.base.message.message_dot_xml.MessageDotXML
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/message_handler.rst

@@ -0,0 +1,15 @@
+:mod:`message_handler`
+======================
+
+.. automodule:: pyogp.lib.base.message.message_handler
+
+.. autoclass:: pyogp.lib.base.message.message_handler.MessageHandledNotifier
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.message_handler.MessageHandler
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/message_manager.rst

@@ -0,0 +1,10 @@
+:mod:`message_manager`
+======================
+
+.. automodule:: pyogp.lib.base.message_manager
+
+.. autoclass:: pyogp.lib.base.message_manager.MessageManager
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/msgtypes.rst

@@ -0,0 +1,50 @@
+:mod:`msgtypes`
+===============
+
+.. automodule:: pyogp.lib.base.message.msgtypes
+
+.. autoclass:: pyogp.lib.base.message.msgtypes.PackFlags
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.msgtypes.MsgTrust
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.msgtypes.EndianType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.msgtypes.MsgDeprecation
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.msgtypes.MsgBlockType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.msgtypes.MsgFrequency
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.msgtypes.MsgType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.msgtypes.PacketLayout
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.msgtypes.MsgEncoding
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/net.rst

@@ -0,0 +1,10 @@
+:mod:`net`
+==========
+
+.. automodule:: pyogp.lib.base.network.net
+
+.. autoclass:: pyogp.lib.base.network.net.NetUDPClient
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/settings.rst

@@ -0,0 +1,10 @@
+:mod:`settings`
+===============
+
+.. automodule:: pyogp.lib.base.settings
+
+.. autoclass:: pyogp.lib.base.settings.Settings
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/stdlib_client.rst

@@ -0,0 +1,10 @@
+:mod:`stdlib_client`
+====================
+
+.. automodule:: pyogp.lib.base.network.stdlib_client
+
+.. autoclass:: pyogp.lib.base.network.stdlib_client.StdLibClient
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/template.rst

@@ -0,0 +1,45 @@
+:mod:`template`
+===============
+
+.. automodule:: pyogp.lib.base.message.template
+
+.. autoclass:: pyogp.lib.base.message.template.MsgData
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template.MsgBlockType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template.MessageTemplateVariable
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template.MessageTemplateBlock
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template.MsgType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template.MessageTemplate
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template.MsgVariableData
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template.MsgBlockData
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/template_dict.rst

@@ -0,0 +1,35 @@
+:mod:`template_dict`
+====================
+
+.. automodule:: pyogp.lib.base.message.template_dict
+
+.. autoclass:: pyogp.lib.base.message.template_dict.MessageTemplateParser
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_dict.MsgFrequency
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_dict.EndianType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_dict.MsgType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_dict.TemplateDictionary
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_dict.DataPacker
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/template_parser.rst

@@ -0,0 +1,40 @@
+:mod:`template_parser`
+======================
+
+.. automodule:: pyogp.lib.base.message.template_parser
+
+.. autoclass:: pyogp.lib.base.message.template_parser.MsgTrust
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_parser.MessageTemplateParser
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_parser.MsgDeprecation
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_parser.MsgBlockType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_parser.MsgFrequency
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_parser.MsgType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.template_parser.MsgEncoding
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/udpdeserializer.rst

@@ -0,0 +1,70 @@
+:mod:`udpdeserializer`
+======================
+
+.. automodule:: pyogp.lib.base.message.udpdeserializer
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.PackFlags
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.DataUnpacker
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.MsgData
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.MsgBlockType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.EndianType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.MsgFrequency
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.PacketLayout
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.TemplateDictionary
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.MsgType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.Message
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.MsgVariableData
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.UDPMessageDeserializer
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdeserializer.MsgBlockData
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/udpdispatcher.rst

@@ -0,0 +1,70 @@
+:mod:`udpdispatcher`
+====================
+
+.. automodule:: pyogp.lib.base.message.udpdispatcher
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.PackFlags
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.DataUnpacker
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.CircuitManager
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.MsgBlockType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.EndianType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.MsgFrequency
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.UDPMessageSerializer
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.PacketLayout
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.MsgType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.Message
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.UDPDispatcher
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.UDPMessageDeserializer
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpdispatcher.Block
+  :members:
+  :undoc-members:
+  :inherited-members:
+

docs/source/modules/udpserializer.rst

@@ -0,0 +1,35 @@
+:mod:`udpserializer`
+====================
+
+.. automodule:: pyogp.lib.base.message.udpserializer
+
+.. autoclass:: pyogp.lib.base.message.udpserializer.MsgBlockType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpserializer.EndianType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpserializer.MsgType
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpserializer.TemplateDictionary
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpserializer.DataPacker
+  :members:
+  :undoc-members:
+  :inherited-members:
+
+.. autoclass:: pyogp.lib.base.message.udpserializer.UDPMessageSerializer
+  :members:
+  :undoc-members:
+  :inherited-members:
+