mock doc changes

martinohanlon · Dec 31, 2018 · 9e1711b · 9e1711b
1 parent d03188d
commit 9e1711b
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 11 deletions.
diff --git a/bluedot/mock.py b/bluedot/mock.py
@@ -157,14 +157,24 @@ def __init__(self,
             auto_connect)
 
     def connect(self):
+        """
+        Connect to a Bluetooth server.
+        """
         self._server.mock_client_connected(self)
         self._connected = True
 
     def disconnect(self):
+        """
+        Disconnect from a Bluetooth server.
+        """
         self._server.mock_client_disconnected()
         self._connected = False
 
     def mock_server_sending_data(self, data):
+        """
+        Simulates a server sending data to the
+        :class:`~.btcomm.BluetoothClient`.
+        """
         if self._connected:
             self._data_received_callback(data)
 

diff --git a/docs/btcommapi.rst b/docs/btcommapi.rst
@@ -25,9 +25,3 @@ BluetoothAdapter
 
 .. autoclass:: BluetoothAdapter
 
-MockBluetoothServer
--------------------
-
-.. module:: bluedot.mock
-
-.. autoclass:: MockBluetoothServer
diff --git a/docs/dotapi.rst b/docs/dotapi.rst
@@ -27,8 +27,3 @@ BlueDotRotation
 ---------------
 
 .. autoclass:: BlueDotRotation
-
-MockBlueDot
------------
-
-.. autoclass:: MockBlueDot
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ Table of Contents
    bluedotpythonapp
    dotapi
    btcommapi
+   mockapi
    protocol
    build
    changelog
diff --git a/docs/mockapi.rst b/docs/mockapi.rst
@@ -0,0 +1,22 @@
+Mock API
+========
+Blue Dot also contains a useful :mod:`mock` API for simulating Blue Dot and
+bluetooth comms. This is useful for testing and allows for prototyping
+without having to use a Blue Dot client.
+
+.. module:: bluedot.mock
+
+MockBlueDot
+-----------
+
+.. autoclass:: MockBlueDot
+
+MockBluetoothServer
+-------------------
+
+.. autoclass:: MockBluetoothServer
+
+MockBluetoothClient
+-------------------
+
+.. autoclass:: MockBluetoothClient