Updated docs to include plugins

docs/source/index.rst

@@ -7,6 +7,7 @@ Welcome to OpenFlexure Microscope Software's documentation!
 
    microscope.rst
    camera.rst
+   plugins.rst
    api.rst
 
 

docs/source/microscope.rst

@@ -5,5 +5,5 @@ Microscope class
    :maxdepth: 2
    :caption: Contents:
 
-.. automodule:: openflexure_microscope.microscope
+.. automodule:: openflexure_microscope
     :members:

docs/source/plugins.rst

@@ -0,0 +1,11 @@
+Plugin System
+=============
+
+.. automodule:: openflexure_microscope.plugins
+    :members:
+
+Example Plugin
+--------------
+
+.. automodule:: openflexure_microscope.plugins.default.test_plugin
+    :members:

openflexure_microscope/__init__.py

@@ -1,3 +1,4 @@
-from .microscope import Microscope
-
+__all__ = ['Microscope']
 __version__ = "0.1.0"
+
+from .microscope import Microscope

openflexure_microscope/plugins/__init__.py

@@ -1 +1,3 @@
+__all__ = ['search_plugin_dirs', 'find_plugins', 'load_plugin', 'PluginMount', 'MicroscopePlugin']
+
 from .loader import search_plugin_dirs, find_plugins, load_plugin, PluginMount, MicroscopePlugin

openflexure_microscope/plugins/default/test_plugin/__init__.py

@@ -21,6 +21,9 @@ class OtherPlugin(MicroscopePlugin):
     An example of a second Microscope plugin, loaded from the same plugin file.
     """
     def run(self):
+        """
+        Demonstrate access to Microscope.camera, and Microscope.stage
+        """
         print("Stage plugin parent stage:")
         print(self.stage)