From 034a45e400750c5b316783fe2910f3b8f34cd9ca Mon Sep 17 00:00:00 2001 From: Joel Collins Date: Fri, 23 Nov 2018 17:34:20 +0000 Subject: [PATCH] Updated docs to include plugins --- docs/source/index.rst | 1 + docs/source/microscope.rst | 2 +- docs/source/plugins.rst | 11 +++++++++++ openflexure_microscope/__init__.py | 5 +++-- openflexure_microscope/plugins/__init__.py | 2 ++ .../plugins/default/test_plugin/__init__.py | 3 +++ 6 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 docs/source/plugins.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index fc003f62..1ef64d3f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,6 +7,7 @@ Welcome to OpenFlexure Microscope Software's documentation! microscope.rst camera.rst + plugins.rst api.rst diff --git a/docs/source/microscope.rst b/docs/source/microscope.rst index 13cd25ab..b706eb2c 100644 --- a/docs/source/microscope.rst +++ b/docs/source/microscope.rst @@ -5,5 +5,5 @@ Microscope class :maxdepth: 2 :caption: Contents: -.. automodule:: openflexure_microscope.microscope +.. automodule:: openflexure_microscope :members: \ No newline at end of file diff --git a/docs/source/plugins.rst b/docs/source/plugins.rst new file mode 100644 index 00000000..bd8a29b9 --- /dev/null +++ b/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: \ No newline at end of file diff --git a/openflexure_microscope/__init__.py b/openflexure_microscope/__init__.py index b5bdcd1f..ceaa4d3a 100644 --- a/openflexure_microscope/__init__.py +++ b/openflexure_microscope/__init__.py @@ -1,3 +1,4 @@ -from .microscope import Microscope - +__all__ = ['Microscope'] __version__ = "0.1.0" + +from .microscope import Microscope diff --git a/openflexure_microscope/plugins/__init__.py b/openflexure_microscope/plugins/__init__.py index 7d1f1cfc..e552673e 100644 --- a/openflexure_microscope/plugins/__init__.py +++ b/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 \ No newline at end of file diff --git a/openflexure_microscope/plugins/default/test_plugin/__init__.py b/openflexure_microscope/plugins/default/test_plugin/__init__.py index 7bd18bf3..8cd3872a 100644 --- a/openflexure_microscope/plugins/default/test_plugin/__init__.py +++ b/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)