Fixed documentation (still needs rewriting)

docs/source/api.rst

@@ -5,7 +5,6 @@ Summary
 -------
 .. qrefflask:: openflexure_microscope.api.app:app
    :undoc-endpoints: index
-   :blueprints: v2_root_blueprint, v2_streams_blueprint, v2_captures_blueprint, v2_settings_blueprint, v2_status_blueprint, v2_plugin_blueprint, v2_tasks_blueprint, v2_actions_blueprint
    :undoc-static:
    :endpoints:
 
@@ -13,7 +12,6 @@ Details
 -------
 .. autoflask:: openflexure_microscope.api.app:app
    :undoc-endpoints: index
-   :blueprints: v2_root_blueprint, v2_streams_blueprint, v2_captures_blueprint, v2_settings_blueprint, v2_status_blueprint, v2_plugin_blueprint, v2_tasks_blueprint, v2_actions_blueprint
    :undoc-static:
    :endpoints:
    :order: path

docs/source/plugins/class.rst

@@ -1,29 +1,7 @@
 Classes and Modules
 ===================
 
-Plugin class
-------------
-.. autoclass:: openflexure_microscope.plugins.MicroscopePlugin
-    :members:
-
-.. autoclass:: openflexure_microscope.api.v1.views.MicroscopeViewPlugin
-    :members:
-
-
-Default plugins
+Extension class
 ---------------
-
-Autofocus
-+++++++++
-.. automodule:: openflexure_microscope.plugins.default.autofocus
-    :members:
-
-Camera calibration
-++++++++++++++++++
-.. automodule:: openflexure_microscope.plugins.default.camera_calibration
-    :members:
-
-Scan and Stack
-++++++++++++++
-.. automodule:: openflexure_microscope.plugins.default.scan
+.. autoclass:: openflexure_microscope.common.flask_labthings.extensions.BaseExtension
     :members:

docs/source/plugins/forms.rst

@@ -184,9 +184,3 @@ JSON form example
 
 .. literalinclude:: forms_example.json
   :language: JSON
-
-
-.. toctree::
-   :maxdepth: 1
-
-   ./form/json_form.rst

docs/source/plugins/forms_example.json

@@ -1,16 +1,14 @@
 {
   "id": "test-plugin",
   "icon": "pets",
-    "forms": [
-      {
+  "forms": [{
       "name": "Simple request",
       "isCollapsible": false,
       "isTask": false,
       "selfUpdate": true,
       "route": "/do",
       "submitLabel": "Do things",
-        "schema": [
-          {
+      "schema": [{
           "fieldType": "numberInput",
           "placeholder": "Some integer",
           "name": "val_int",
@@ -75,13 +73,11 @@
       "selfUpdate": true,
       "route": "/task",
       "submitLabel": "Start task",
-        "schema": [
-            {
+      "schema": [{
         "fieldType": "numberInput",
         "name": "run_time",
         "label": "Run time (seconds)"
-            }
-        ]
+      }]
     }
   ]
 }

docs/source/quickstart.rst

@@ -5,7 +5,7 @@ Install
 -------
 
 Stable installation
-+++++++++++++++
++++++++++++++++++++
 For most users, this is the reccommended installation method.
 
 - Run ``curl -LSs get.openflexure.org/microscope |sudo bash``
@@ -13,7 +13,7 @@ For most users, this is the reccommended installation method.
 - Follow on-screen prompts
 
 Developer and non-interactive installation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 The installer script can pull the latest development package from our git repository, and use install into a developer environment using Poetry. 
 Options also exist to run the installer without any user prompts.
 

openflexure_microscope/camera/pi.py

@@ -4,16 +4,21 @@
 Raspberry Pi camera implementation of the PiCameraStreamer class.
 
 NOTES:
-Still port used for image capture
-Preview port reserved for onboard GPU preview
+
+Still port used for image capture.
+Preview port reserved for onboard GPU preview.
+
 Video port:
-    Splitter port 0: Image capture (if use_video_port == True)
-    Splitter port 1: Streaming frames
-    Splitter port 2: Video capture
-    Splitter port 3: [Currently unused]
+
+* Splitter port 0: Image capture (if use_video_port == True)
+* Splitter port 1: Streaming frames
+* Splitter port 2: Video capture
+* Splitter port 3: [Currently unused]
 
 PiCameraStreamer streams at video_resolution
+
 Camera capture resolution set to stream_resolution in frames()
+
 Video port uses that resolution for everything. If a different resolution
 is specified for video capture, this is handled by the resizer.