Update documentation for 0.3.2

Tuxemon · Mar 14, 2016 · d3a341a · d3a341a
1 parent 019dd2c
commit d3a341a
Show file tree

Hide file tree

Showing 77 changed files with 731 additions and 0 deletions.
diff --git a/docs/tuxemon.core.components.ai.rst b/docs/tuxemon.core.components.ai.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.ai module
+=================================
+
+.. automodule:: tuxemon.core.components.ai
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.animation.rst b/docs/tuxemon.core.components.animation.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.animation module
+========================================
+
+.. automodule:: tuxemon.core.components.animation
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.cli.rst b/docs/tuxemon.core.components.cli.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.cli module
+==================================
+
+.. automodule:: tuxemon.core.components.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.config.rst b/docs/tuxemon.core.components.config.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.config module
+=====================================
+
+.. automodule:: tuxemon.core.components.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.controller.rst b/docs/tuxemon.core.components.controller.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.controller module
+=========================================
+
+.. automodule:: tuxemon.core.components.controller
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.db.rst b/docs/tuxemon.core.components.db.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.db module
+=================================
+
+.. automodule:: tuxemon.core.components.db
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.actions.combat.rst b/docs/tuxemon.core.components.event.actions.combat.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.actions.combat module
+===================================================
+
+.. automodule:: tuxemon.core.components.event.actions.combat
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.actions.core.rst b/docs/tuxemon.core.components.event.actions.core.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.actions.core module
+=================================================
+
+.. automodule:: tuxemon.core.components.event.actions.core
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.actions.map.rst b/docs/tuxemon.core.components.event.actions.map.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.actions.map module
+================================================
+
+.. automodule:: tuxemon.core.components.event.actions.map
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.actions.npc.rst b/docs/tuxemon.core.components.event.actions.npc.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.actions.npc module
+================================================
+
+.. automodule:: tuxemon.core.components.event.actions.npc
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.actions.player.rst b/docs/tuxemon.core.components.event.actions.player.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.actions.player module
+===================================================
+
+.. automodule:: tuxemon.core.components.event.actions.player
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.actions.rst b/docs/tuxemon.core.components.event.actions.rst
@@ -0,0 +1,20 @@
+tuxemon.core.components.event.actions package
+=============================================
+
+.. automodule:: tuxemon.core.components.event.actions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxemon.core.components.event.actions.combat
+   tuxemon.core.components.event.actions.core
+   tuxemon.core.components.event.actions.map
+   tuxemon.core.components.event.actions.npc
+   tuxemon.core.components.event.actions.player
+   tuxemon.core.components.event.actions.sound
+
diff --git a/docs/tuxemon.core.components.event.actions.sound.rst b/docs/tuxemon.core.components.event.actions.sound.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.actions.sound module
+==================================================
+
+.. automodule:: tuxemon.core.components.event.actions.sound
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.conditions.combat.rst b/docs/tuxemon.core.components.event.conditions.combat.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.conditions.combat module
+======================================================
+
+.. automodule:: tuxemon.core.components.event.conditions.combat
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.conditions.core.rst b/docs/tuxemon.core.components.event.conditions.core.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.conditions.core module
+====================================================
+
+.. automodule:: tuxemon.core.components.event.conditions.core
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.conditions.music.rst b/docs/tuxemon.core.components.event.conditions.music.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.conditions.music module
+=====================================================
+
+.. automodule:: tuxemon.core.components.event.conditions.music
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.conditions.npc.rst b/docs/tuxemon.core.components.event.conditions.npc.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.conditions.npc module
+===================================================
+
+.. automodule:: tuxemon.core.components.event.conditions.npc
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.conditions.player.rst b/docs/tuxemon.core.components.event.conditions.player.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.event.conditions.player module
+======================================================
+
+.. automodule:: tuxemon.core.components.event.conditions.player
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.event.conditions.rst b/docs/tuxemon.core.components.event.conditions.rst
@@ -0,0 +1,19 @@
+tuxemon.core.components.event.conditions package
+================================================
+
+.. automodule:: tuxemon.core.components.event.conditions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxemon.core.components.event.conditions.combat
+   tuxemon.core.components.event.conditions.core
+   tuxemon.core.components.event.conditions.music
+   tuxemon.core.components.event.conditions.npc
+   tuxemon.core.components.event.conditions.player
+
diff --git a/docs/tuxemon.core.components.event.rst b/docs/tuxemon.core.components.event.rst
@@ -0,0 +1,16 @@
+tuxemon.core.components.event package
+=====================================
+
+.. automodule:: tuxemon.core.components.event
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    tuxemon.core.components.event.actions
+    tuxemon.core.components.event.conditions
+
diff --git a/docs/tuxemon.core.components.eztext.rst b/docs/tuxemon.core.components.eztext.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.eztext module
+=====================================
+
+.. automodule:: tuxemon.core.components.eztext
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.fusion.rst b/docs/tuxemon.core.components.fusion.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.fusion module
+=====================================
+
+.. automodule:: tuxemon.core.components.fusion
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.item.rst b/docs/tuxemon.core.components.item.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.item module
+===================================
+
+.. automodule:: tuxemon.core.components.item
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.log.rst b/docs/tuxemon.core.components.log.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.log module
+==================================
+
+.. automodule:: tuxemon.core.components.log
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.map.rst b/docs/tuxemon.core.components.map.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.map module
+==================================
+
+.. automodule:: tuxemon.core.components.map
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.menu.interface.rst b/docs/tuxemon.core.components.menu.interface.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.menu.interface module
+=============================================
+
+.. automodule:: tuxemon.core.components.menu.interface
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.menu.menu.rst b/docs/tuxemon.core.components.menu.menu.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.menu.menu module
+========================================
+
+.. automodule:: tuxemon.core.components.menu.menu
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.menu.rst b/docs/tuxemon.core.components.menu.rst
@@ -0,0 +1,16 @@
+tuxemon.core.components.menu package
+====================================
+
+.. automodule:: tuxemon.core.components.menu
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxemon.core.components.menu.interface
+   tuxemon.core.components.menu.menu
+
diff --git a/docs/tuxemon.core.components.middleware.rst b/docs/tuxemon.core.components.middleware.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.middleware module
+=========================================
+
+.. automodule:: tuxemon.core.components.middleware
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.monster.rst b/docs/tuxemon.core.components.monster.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.monster module
+======================================
+
+.. automodule:: tuxemon.core.components.monster
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.networking.rst b/docs/tuxemon.core.components.networking.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.networking module
+=========================================
+
+.. automodule:: tuxemon.core.components.networking
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.player.rst b/docs/tuxemon.core.components.player.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.player module
+=====================================
+
+.. automodule:: tuxemon.core.components.player
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.plugin.rst b/docs/tuxemon.core.components.plugin.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.plugin module
+=====================================
+
+.. automodule:: tuxemon.core.components.plugin
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.pyganim.rst b/docs/tuxemon.core.components.pyganim.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.pyganim module
+======================================
+
+.. automodule:: tuxemon.core.components.pyganim
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.rst b/docs/tuxemon.core.components.rst
@@ -0,0 +1,45 @@
+tuxemon.core.components package
+===============================
+
+.. automodule:: tuxemon.core.components
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    tuxemon.core.components.event
+    tuxemon.core.components.menu
+    tuxemon.core.components.rumble
+    tuxemon.core.components.status
+    tuxemon.core.components.ui
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxemon.core.components.ai
+   tuxemon.core.components.animation
+   tuxemon.core.components.cli
+   tuxemon.core.components.config
+   tuxemon.core.components.controller
+   tuxemon.core.components.db
+   tuxemon.core.components.eztext
+   tuxemon.core.components.fusion
+   tuxemon.core.components.item
+   tuxemon.core.components.log
+   tuxemon.core.components.map
+   tuxemon.core.components.middleware
+   tuxemon.core.components.monster
+   tuxemon.core.components.networking
+   tuxemon.core.components.player
+   tuxemon.core.components.plugin
+   tuxemon.core.components.pyganim
+   tuxemon.core.components.save
+   tuxemon.core.components.screen
+   tuxemon.core.components.sprite
+
diff --git a/docs/tuxemon.core.components.rumble.libshake.rst b/docs/tuxemon.core.components.rumble.libshake.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.rumble.libshake module
+==============================================
+
+.. automodule:: tuxemon.core.components.rumble.libshake
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/tuxemon.core.components.rumble.rst b/docs/tuxemon.core.components.rumble.rst
@@ -0,0 +1,16 @@
+tuxemon.core.components.rumble package
+======================================
+
+.. automodule:: tuxemon.core.components.rumble
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   tuxemon.core.components.rumble.libshake
+   tuxemon.core.components.rumble.tools
+
diff --git a/docs/tuxemon.core.components.rumble.tools.rst b/docs/tuxemon.core.components.rumble.tools.rst
@@ -0,0 +1,7 @@
+tuxemon.core.components.rumble.tools module
+===========================================
+
+.. automodule:: tuxemon.core.components.rumble.tools
+    :members:
+    :undoc-members:
+    :show-inheritance: