Merge pull request labscript-suite#69 from dihm/labscript_utils-docs

philipstarkey · web-flow · commit dce6ac8a7d04 · 2020-11-02T10:19:40.000+11:00
Increasing API coverage for labscript_utils components.
diff --git a/docs/source/api/connections.rst b/docs/source/api/connections.rst
@@ -4,4 +4,5 @@ labscript_utils.connections
 
 .. automodule:: labscript_utils.connections
    :members:
-   :undoc-members:
+   :undoc-members:
+   :private-members:
diff --git a/docs/source/api/dict_diff.rst b/docs/source/api/dict_diff.rst
@@ -0,0 +1,8 @@
+=========================
+labscript_utils.dict_diff
+=========================
+
+.. automodule:: labscript_utils.dict_diff
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/double_import_denier.rst b/docs/source/api/double_import_denier.rst
@@ -0,0 +1,8 @@
+====================================
+labscript_utils.double_import_denier
+====================================
+
+.. automodule:: labscript_utils.double_import_denier
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/filewatcher.rst b/docs/source/api/filewatcher.rst
@@ -0,0 +1,8 @@
+===========================
+labscript_utils.filewatcher
+===========================
+
+.. automodule:: labscript_utils.filewatcher
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/h5_lock.rst b/docs/source/api/h5_lock.rst
@@ -0,0 +1,8 @@
+=======================
+labscript_utils.h5_lock
+=======================
+
+.. automodule:: labscript_utils.h5_lock
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/impprof.rst b/docs/source/api/impprof.rst
@@ -0,0 +1,8 @@
+=======================
+labscript_utils.impprof
+=======================
+
+.. automodule:: labscript_utils.impprof
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -2,8 +2,61 @@
 API Reference
 *************
 
+Labscript Tools
+~~~~~~~~~~~~~~~
+
 .. toctree::
    :maxdepth: 2
 
    labscript_utils
-   connections
+   connections
+   dict_diff
+   labconfig
+   settings
+   testing_utils
+   properties
+   unitconversions
+
+Communications
+~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   h5_lock
+   ls_zprocess
+   remote
+   shared_drive
+   zlock
+   zlog
+
+GUI
+~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   splash
+   qtwidgets
+
+Logging and Profiling
+~~~~~~~~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2
+
+   impprof
+   memprof
+   setup_logging
+   tracelog
+
+
+Module and File Tools
+~~~~~~~~~~~~~~~~~~~~~
+
+.. toctree::
+   :maxdepth: 2 
+   
+   double_import_denier
+   filewatcher
+   modulewatcher
diff --git a/docs/source/api/labconfig.rst b/docs/source/api/labconfig.rst
@@ -0,0 +1,8 @@
+=========================
+labscript_utils.labconfig
+=========================
+
+.. automodule:: labscript_utils.labconfig
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/ls_zprocess.rst b/docs/source/api/ls_zprocess.rst
@@ -0,0 +1,8 @@
+===========================
+labscript_utils.ls_zprocess
+===========================
+
+.. automodule:: labscript_utils.ls_zprocess
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/memprof.rst b/docs/source/api/memprof.rst
@@ -0,0 +1,8 @@
+=======================
+labscript_utils.memprof
+=======================
+
+.. automodule:: labscript_utils.memprof
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/modulewatcher.rst b/docs/source/api/modulewatcher.rst
@@ -0,0 +1,8 @@
+=============================
+labscript_utils.modulewatcher
+=============================
+
+.. automodule:: labscript_utils.modulewatcher
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/properties.rst b/docs/source/api/properties.rst
@@ -0,0 +1,8 @@
+==========================
+labscript_utils.properties
+==========================
+
+.. automodule:: labscript_utils.properties
+   :members:
+   :undoc-members:
+   :private-members:
diff --git a/docs/source/api/qtwidgets.rst b/docs/source/api/qtwidgets.rst
@@ -0,0 +1,78 @@
+=========================
+labscript_utils.qtwidgets
+=========================
+
+.. automodule:: labscript_utils.qtwidgets
+	:members:
+	:undoc-members:
+
+Helper Widgets
+~~~~~~~~~~~~~~
+
+.. automodule:: labscript_utils.qtwidgets.dragdroptab
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.elide_label
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.fingertab
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.headerview_with_widgets
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.InputPlotWindow
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.outputbox
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.toolpalette
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+Input/Output Widgets
+~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: labscript_utils.qtwidgets.analoginput
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.analogoutput
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.ddsoutput
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.digitaloutput
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.enumoutput
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.qtwidgets.imageoutput
+	:members:
+	:undoc-members:
+	:show-inheritance:
diff --git a/docs/source/api/remote.rst b/docs/source/api/remote.rst
@@ -0,0 +1,8 @@
+======================
+labscript_utils.remote
+======================
+
+.. automodule:: labscript_utils.remote
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/settings.rst b/docs/source/api/settings.rst
@@ -0,0 +1,8 @@
+========================
+labscript_utils.settings
+========================
+
+.. automodule:: labscript_utils.settings
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/setup_logging.rst b/docs/source/api/setup_logging.rst
@@ -0,0 +1,8 @@
+=============================
+labscript_utils.setup_logging
+=============================
+
+.. automodule:: labscript_utils.setup_logging
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/shared_drive.rst b/docs/source/api/shared_drive.rst
@@ -0,0 +1,8 @@
+============================
+labscript_utils.shared_drive
+============================
+
+.. automodule:: labscript_utils.shared_drive
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/splash.rst b/docs/source/api/splash.rst
@@ -0,0 +1,8 @@
+======================
+labscript_utils.splash
+======================
+
+.. automodule:: labscript_utils.splash
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/testing_utils.rst b/docs/source/api/testing_utils.rst
@@ -0,0 +1,8 @@
+=============================
+labscript_utils.testing_utils
+=============================
+
+.. automodule:: labscript_utils.testing_utils
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/tracelog.rst b/docs/source/api/tracelog.rst
@@ -0,0 +1,8 @@
+========================
+labscript_utils.tracelog
+========================
+
+.. automodule:: labscript_utils.tracelog
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/unitconversions.rst b/docs/source/api/unitconversions.rst
@@ -0,0 +1,64 @@
+===============================
+labscript_utils.unitconversions
+===============================
+
+.. automodule:: labscript_utils.unitconversions
+	:members:
+	:undoc-members:
+
+Basic Unit Conversion Classes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: labscript_utils.unitconversions.test
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.unitconversions.example
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.unitconversions.UnitConversionBase
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+Unit Conversion Classes
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: labscript_utils.unitconversions.aom
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.unitconversions.detuning
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.unitconversions.linear_coil_driver
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.unitconversions.NovaTechDDS9m
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.unitconversions.optotunelens
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.unitconversions.quad_driver
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
+.. automodule:: labscript_utils.unitconversions.quad_monitor
+	:members:
+	:undoc-members:
+	:show-inheritance:
+
diff --git a/docs/source/api/zlock.rst b/docs/source/api/zlock.rst
@@ -0,0 +1,8 @@
+=====================
+labscript_utils.zlock
+=====================
+
+.. automodule:: labscript_utils.zlock
+	:members:
+	:undoc-members:
+	:private-members:
diff --git a/docs/source/api/zlog.rst b/docs/source/api/zlog.rst
diff --git a/labscript_utils/remote.py b/labscript_utils/remote.py
diff --git a/labscript_utils/zlock.py b/labscript_utils/zlock.py
diff --git a/labscript_utils/zlog.py b/labscript_utils/zlog.py
