Commit 034a45e4 authored Nov 23, 2018 by Joel Collins

Updated docs to include plugins

parent 2ef6395b

docs/source/index.rst

+1 −0

Original line number	Diff line number	Diff line
		@@ -7,6 +7,7 @@ Welcome to OpenFlexure Microscope Software's documentation!

		microscope.rst
		camera.rst
		plugins.rst
		api.rst

docs/source/microscope.rst

+1 −1

Original line number	Diff line number	Diff line
		@@ -5,5 +5,5 @@ Microscope class
		:maxdepth: 2
		:caption: Contents:

		.. automodule:: openflexure_microscope.microscope
		.. automodule:: openflexure_microscope
		:members:
		No newline at end of file

docs/source/plugins.rst

0 → 100644

+11 −0

Original line number	Diff line number	Diff line
		Plugin System
		=============

		.. automodule:: openflexure_microscope.plugins
		:members:

		Example Plugin
		--------------

		.. automodule:: openflexure_microscope.plugins.default.test_plugin
		:members:
		No newline at end of file

openflexure_microscope/init.py

+3 −2

Original line number	Diff line number	Diff line
		from .microscope import Microscope

		__all__ = ['Microscope']
		__version__ = "0.1.0"

		from .microscope import Microscope

openflexure_microscope/plugins/init.py

+2 −0

Original line number	Diff line number	Diff line
		__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