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

Started re-writing plugin documentation

Browse source
This commit is contained in:
Joel Collins 2018-12-20 11:31:50 +00:00
parent 367c68ad6f
commit d681a2069d
7 changed files with 54 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/source/camera.rst
View file

@ -3,7 +3,6 @@ Camera Functionality
.. toctree::
:maxdepth: 2
:caption: Contents:
picamera.rst
basecamera.rst

17
docs/source/pluginmounts.rst Normal file
View file

@ -0,0 +1,17 @@
Plugin mounts
===============
.. automodule:: openflexure_microscope.plugins
:members:
Default plugins
===============
Microscope plugin
+++++++++++++++++
.. automodule:: openflexure_microscope.plugins.default.plugin
:members:
Web API plugin
++++++++++++++
.. automodule:: openflexure_microscope.plugins.default.api
:members:

32
docs/source/plugins.rst
View file

@ -1,11 +1,27 @@
Plugin System
=============
Plugins
=======================================================
.. automodule:: openflexure_microscope.plugins
:members:
Introduction
------------
Example Plugin
--------------
Single-file plugins
+++++++++++++++++++
.. automodule:: openflexure_microscope.plugins.default.test_plugin
:members:
Package plugins
+++++++++++++++
Loading plugins with microscoperc.yaml
++++++++++++++++++++++++++++++++++++++
Microscope plugin structure
---------------------------
Adding web API routes
---------------------
Mounting and built-ins
----------------------
.. toctree::
:maxdepth: 2
pluginmounts.rst