diff --git a/docs/source/plugins.rst b/docs/source/plugins.rst index 6fcea5c6..6a57425b 100644 --- a/docs/source/plugins.rst +++ b/docs/source/plugins.rst @@ -44,9 +44,9 @@ For example, the plugins section of your microscoperc.yaml file may look like: Microscope plugin structure --------------------------- -As described earlier, a plugin must subclass :py:class:`openflexure_microscope.plugins.MicroscopePlugin`. Each plugin in described by a single class, containing any number of methods. The methods defined within your plugin class will be attached to the microscope. By subclassing :py:class:`openflexure_microscope.plugins.MicroscopePlugin`, your methods automatically get access to the microscope object your plugin is attached to, through `self.microscope`. This is an instance of :py:class:`openflexure_microscope.Microscope`, and gives unrestricted access to the attached camera and stage hardware. +As described earlier, a plugin must subclass :py:class:`openflexure_microscope.plugins.MicroscopePlugin`. Each plugin in described by a single class, containing any number of methods. The methods defined within your plugin class will be attached to the microscope. By subclassing :py:class:`openflexure_microscope.plugins.MicroscopePlugin`, your methods automatically get access to the microscope object your plugin is attached to, through ``self.microscope``. This is an instance of :py:class:`openflexure_microscope.Microscope`, and gives unrestricted access to the attached camera and stage hardware. -For example, a simple plugin file named `myplugin.py`, may look like: +For example, a simple plugin file named ``myplugin.py``, may look like: .. code-block:: python @@ -73,7 +73,7 @@ For example, a simple plugin file named `myplugin.py`, may look like: return "Hello world!" -When this plugin is loaded and attached to a microscope object named `microscope`, the plugin methods will be available at `microscope.plugin.myplugin.identify()` and `microscope.plugin.myplugin.hello_world()`. +When this plugin is loaded and attached to a microscope object named ``microscope``, the plugin methods will be available at ``microscope.plugin.myplugin.identify()`` and ``microscope.plugin.myplugin.hello_world()``. Adding web API routes ---------------------