Added wpilib extensions docs.

docs/yeti_api.rst

@@ -23,6 +23,11 @@ Two different Interfaces are default to yeti -- events and datastreams.
 .. autosummary::
     yeti.interfaces
 
+Yeti also comes with a set of convenient extensions to wpilib, which are designed to make module programming easier.
+
+.. autosummary::
+    yeti.wpilib_extensions
+
 .. toctree::
     :hidden:
 
@@ -31,4 +36,5 @@ Two different Interfaces are default to yeti -- events and datastreams.
     yeti_api/Context
     yeti_api/ModuleLoader
     yeti_api/ConfigManager
-    yeti_api/Interfaces
+    yeti_api/Interfaces
+    yeti_api/WpilibExtensions

docs/yeti_api/Interfaces.rst

@@ -6,7 +6,7 @@ Module Interfaces
 
 Interfaces are the primary method for inter-module communication. They store data in
 the current :class:`yeti.Context` using it's :meth:`yeti.Context.get_interface_data()` method. Yeti comes
-with two default Interfaces, which should be sufficient for most uses. However, more may easily
+with a few default Interfaces, which should be sufficient for most uses. However, more may easily
 be created to expand Yeti's functionality.
 
 Events
@@ -22,9 +22,18 @@ asyncio events by name.
 Datastreams
 -----------
 
-interfaces.datastreams is the second default interface mechanism. It provides a system for passing
+interfaces.datastreams is another default interface mechanism. It provides a system for passing
 around data, and triggering asyncio events upon certain conditions.
 
 .. automodule:: yeti.interfaces.datastreams
+    :members:
+    :undoc-members:
+
+Gamemode
+--------
+
+interfaces.gamemode is an interface mechanisim designed for communicating game mode between modules.
+
+.. automodule:: yeti.interfaces.gamemode
     :members:
     :undoc-members:

docs/yeti_api/WpilibExtensions.rst

@@ -0,0 +1,25 @@
+
+WPILIB Extensions
+=================
+
+.. automodule:: yeti.wpilib_extensions
+
+This is a set of extensions to 2015 RoboPy to aid development with Yeti.
+
+Buttons
+-------
+
+Buttons is a utility class designed to make joystick-triggered actions easy to implement.
+
+.. autoclass:: yeti.wpilib_extensions.Button
+    :members:
+    :undoc-members:
+
+Referee
+-------
+
+This is a utility class designed to watch created wpilib objects and cleanly deallocate them upon module unload.
+
+.. autoclass:: yeti.wpilib_extensions.Referee
+    :members:
+    :undoc-members:

yeti/interfaces/gamemode.py

@@ -43,6 +43,8 @@ def wait_for_gamemode(modes, context=None):
     """
     Waits until one of the indicated modes is set.
 
+    This is an asyncio coroutine.
+
     :param modes: One or more modes to wait for.
     :param context: The optional context to use for data storage. If none, the current
         thread’s context will be used.
@@ -77,6 +79,8 @@ def wait_for_disabled(context=None):
     """
     Waits until the disabled mode is set.
 
+    This is an asyncio coroutine.
+
     :param context: The optional context to use for data storage. If none, the current
         thread’s context will be used.
     """
@@ -87,6 +91,8 @@ def wait_for_teleop(context=None):
     """
     Waits until the teleoperated mode is set.
 
+    This is an asyncio coroutine.
+
     :param context: The optional context to use for data storage. If none, the current
         thread’s context will be used.
     """
@@ -97,6 +103,8 @@ def wait_for_autonomous(context=None):
     """
     Waits until the autonomous mode is set.
 
+    This is an asyncio coroutine.
+
     :param context: The optional context to use for data storage. If none, the current
         thread’s context will be used.
     """
@@ -107,6 +115,8 @@ def wait_for_enabled(context=None):
     """
     Waits until either the autonomous mode or the teleoperated mode is set.
 
+    This is an asyncio coroutine.
+
     :param context: The optional context to use for data storage. If none, the current
         thread’s context will be used.
     """