rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated docs

Browse source
This commit is contained in:
jtc42 2019-06-07 13:37:20 +01:00
parent fdbba08b66
commit 235aa984f9
12 changed files with 143 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/source/plugins/class.rst
View file

@ -22,12 +22,17 @@ Lock module
Default plugins
---------------
Microscope plugin
+++++++++++++++++
.. automodule:: openflexure_microscope.plugins.default.plugin
Autofocus
+++++++++
.. automodule:: openflexure_microscope.plugins.default.autofocus
:members:
Web API plugin
++++++++++++++
.. automodule:: openflexure_microscope.plugins.default.api
Camera calibration
++++++++++++++++++
.. automodule:: openflexure_microscope.plugins.default.camera_calibration
:members:
Scan and Stack
++++++++++++++
.. automodule:: openflexure_microscope.plugins.default.scan
:members:

2
docs/source/plugins/introduction.rst
View file

@ -26,7 +26,7 @@ Generally, for adding anything other than very simple functionality, plugins sho
The main restriction is that the plugin package must be importable using an absolute import from within the Python environment being used to load your microscope.
Loading plugins with microscope_settings.yaml
--------------------------------------
---------------------------------------------
Both types of plugin are loaded by specifying the plugin class in your :ref:`MicroscopeRC`. In the case of a single-file plugin, specify the path to the plugin file, followed by the name of your :py:class:`openflexure_microscope.plugins.MicroscopePlugin` child class, separated by a colon. For packaged plugins, specify the absolute module name in place of the path.
For example, the plugins section of your microscope_settings.yaml file may look like: