Started re-writing plugin documentation

openflexure_microscope/microscoperc.default.yaml

@@ -22,5 +22,4 @@ picamera_params:
 
 # Default plugins
 plugins:
-  - openflexure_microscope.plugins.default:Plugin
-  - openflexure_microscope.plugins.test_plugin:FirstPlugin
+  - openflexure_microscope.plugins.default:Plugin

openflexure_microscope/plugins/default/api.py

@@ -7,14 +7,24 @@ import logging
 
 
 class IdentifyAPI(MicroscopeViewPlugin):
-
+    """
+    A simple example API plugin, attached through the main microscope plugin.
+    """
     def get(self):
+        """
+        Method to call when an HTTP GET request is made.
+        """
         data = self.microscope.plugin.default.identify()  # Call a method from our plugin, using the full route
         return Response(escape(data))
 
 
 class HelloWorldAPI(MicroscopeViewPlugin):
-
+    """
+    An even simpler example API plugin, which just returns static data without using the microscope.
+    """
     def get(self):
+        """
+        Method to call when an HTTP GET request is made.
+        """
         data = self.plugin.hello_world()  # Call a method from our plugin, using the MicroscopeViewPlugin.plugin shortcut
         return Response(data)

openflexure_microscope/plugins/test_plugin/__init__.py

@@ -1 +0,0 @@
-from .plugin import FirstPlugin

openflexure_microscope/plugins/test_plugin/plugin.py

@@ -1,14 +0,0 @@
-from openflexure_microscope.plugins import MicroscopePlugin
-
-
-class FirstPlugin(MicroscopePlugin):
-    """
-    An example Microscope plugin. 
-    """
-    def run(self):
-        """
-        Demonstrate access to Microscope.camera, and Microscope.stage
-        """
-
-        response = "My parent camera is {}, and my parent stage is {}.".format(self.microscope.camera, self.microscope.stage)
-        return response