Skip to content

Commit dce6ac8

Browse files
philipstarkeyphilipstarkey
authored
Merge pull request #69 from dihm/labscript_utils-docs
Increasing API coverage for labscript_utils components.
2 parents 5f8280f + f79f77c commit dce6ac8

26 files changed

+377
-26
lines changed

‎docs/source/api/connections.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ labscript_utils.connections
44

55
.. automodule:: labscript_utils.connections
66
:members:
7-
:undoc-members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/dict_diff.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=========================
2+
labscript_utils.dict_diff
3+
=========================
4+
5+
.. automodule:: labscript_utils.dict_diff
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/double_import_denier.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
====================================
2+
labscript_utils.double_import_denier
3+
====================================
4+
5+
.. automodule:: labscript_utils.double_import_denier
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/filewatcher.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
===========================
2+
labscript_utils.filewatcher
3+
===========================
4+
5+
.. automodule:: labscript_utils.filewatcher
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/h5_lock.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=======================
2+
labscript_utils.h5_lock
3+
=======================
4+
5+
.. automodule:: labscript_utils.h5_lock
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/impprof.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=======================
2+
labscript_utils.impprof
3+
=======================
4+
5+
.. automodule:: labscript_utils.impprof
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/index.rst

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,61 @@
22
API Reference
33
*************
44

5+
Labscript Tools
6+
~~~~~~~~~~~~~~~
7+
58
.. toctree::
69
:maxdepth: 2
710

811
labscript_utils
9-
connections
12+
connections
13+
dict_diff
14+
labconfig
15+
settings
16+
testing_utils
17+
properties
18+
unitconversions
19+
20+
Communications
21+
~~~~~~~~~~~~~~
22+
23+
.. toctree::
24+
:maxdepth: 2
25+
26+
h5_lock
27+
ls_zprocess
28+
remote
29+
shared_drive
30+
zlock
31+
zlog
32+
33+
GUI
34+
~~~~
35+
36+
.. toctree::
37+
:maxdepth: 2
38+
39+
splash
40+
qtwidgets
41+
42+
Logging and Profiling
43+
~~~~~~~~~~~~~~~~~~~~~
44+
45+
.. toctree::
46+
:maxdepth: 2
47+
48+
impprof
49+
memprof
50+
setup_logging
51+
tracelog
52+
53+
54+
Module and File Tools
55+
~~~~~~~~~~~~~~~~~~~~~
56+
57+
.. toctree::
58+
:maxdepth: 2
59+
60+
double_import_denier
61+
filewatcher
62+
modulewatcher

‎docs/source/api/labconfig.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=========================
2+
labscript_utils.labconfig
3+
=========================
4+
5+
.. automodule:: labscript_utils.labconfig
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/ls_zprocess.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
===========================
2+
labscript_utils.ls_zprocess
3+
===========================
4+
5+
.. automodule:: labscript_utils.ls_zprocess
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/memprof.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=======================
2+
labscript_utils.memprof
3+
=======================
4+
5+
.. automodule:: labscript_utils.memprof
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/modulewatcher.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=============================
2+
labscript_utils.modulewatcher
3+
=============================
4+
5+
.. automodule:: labscript_utils.modulewatcher
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/properties.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
==========================
2+
labscript_utils.properties
3+
==========================
4+
5+
.. automodule:: labscript_utils.properties
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/qtwidgets.rst

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
=========================
2+
labscript_utils.qtwidgets
3+
=========================
4+
5+
.. automodule:: labscript_utils.qtwidgets
6+
:members:
7+
:undoc-members:
8+
9+
Helper Widgets
10+
~~~~~~~~~~~~~~
11+
12+
.. automodule:: labscript_utils.qtwidgets.dragdroptab
13+
:members:
14+
:undoc-members:
15+
:show-inheritance:
16+
17+
.. automodule:: labscript_utils.qtwidgets.elide_label
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
.. automodule:: labscript_utils.qtwidgets.fingertab
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:
26+
27+
.. automodule:: labscript_utils.qtwidgets.headerview_with_widgets
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
.. automodule:: labscript_utils.qtwidgets.InputPlotWindow
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
.. automodule:: labscript_utils.qtwidgets.outputbox
38+
:members:
39+
:undoc-members:
40+
:show-inheritance:
41+
42+
.. automodule:: labscript_utils.qtwidgets.toolpalette
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Input/Output Widgets
48+
~~~~~~~~~~~~~~~~~~~~
49+
50+
.. automodule:: labscript_utils.qtwidgets.analoginput
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
.. automodule:: labscript_utils.qtwidgets.analogoutput
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
.. automodule:: labscript_utils.qtwidgets.ddsoutput
61+
:members:
62+
:undoc-members:
63+
:show-inheritance:
64+
65+
.. automodule:: labscript_utils.qtwidgets.digitaloutput
66+
:members:
67+
:undoc-members:
68+
:show-inheritance:
69+
70+
.. automodule:: labscript_utils.qtwidgets.enumoutput
71+
:members:
72+
:undoc-members:
73+
:show-inheritance:
74+
75+
.. automodule:: labscript_utils.qtwidgets.imageoutput
76+
:members:
77+
:undoc-members:
78+
:show-inheritance:

‎docs/source/api/remote.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
======================
2+
labscript_utils.remote
3+
======================
4+
5+
.. automodule:: labscript_utils.remote
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/settings.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
========================
2+
labscript_utils.settings
3+
========================
4+
5+
.. automodule:: labscript_utils.settings
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/setup_logging.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=============================
2+
labscript_utils.setup_logging
3+
=============================
4+
5+
.. automodule:: labscript_utils.setup_logging
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/shared_drive.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
============================
2+
labscript_utils.shared_drive
3+
============================
4+
5+
.. automodule:: labscript_utils.shared_drive
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/splash.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
======================
2+
labscript_utils.splash
3+
======================
4+
5+
.. automodule:: labscript_utils.splash
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/testing_utils.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=============================
2+
labscript_utils.testing_utils
3+
=============================
4+
5+
.. automodule:: labscript_utils.testing_utils
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/tracelog.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
========================
2+
labscript_utils.tracelog
3+
========================
4+
5+
.. automodule:: labscript_utils.tracelog
6+
:members:
7+
:undoc-members:
8+
:private-members:

‎docs/source/api/unitconversions.rst

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
===============================
2+
labscript_utils.unitconversions
3+
===============================
4+
5+
.. automodule:: labscript_utils.unitconversions
6+
:members:
7+
:undoc-members:
8+
9+
Basic Unit Conversion Classes
10+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11+
12+
.. automodule:: labscript_utils.unitconversions.test
13+
:members:
14+
:undoc-members:
15+
:show-inheritance:
16+
17+
.. automodule:: labscript_utils.unitconversions.example
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
.. automodule:: labscript_utils.unitconversions.UnitConversionBase
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:
26+
27+
Unit Conversion Classes
28+
~~~~~~~~~~~~~~~~~~~~~~~
29+
30+
.. automodule:: labscript_utils.unitconversions.aom
31+
:members:
32+
:undoc-members:
33+
:show-inheritance:
34+
35+
.. automodule:: labscript_utils.unitconversions.detuning
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
.. automodule:: labscript_utils.unitconversions.linear_coil_driver
41+
:members:
42+
:undoc-members:
43+
:show-inheritance:
44+
45+
.. automodule:: labscript_utils.unitconversions.NovaTechDDS9m
46+
:members:
47+
:undoc-members:
48+
:show-inheritance:
49+
50+
.. automodule:: labscript_utils.unitconversions.optotunelens
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
.. automodule:: labscript_utils.unitconversions.quad_driver
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
.. automodule:: labscript_utils.unitconversions.quad_monitor
61+
:members:
62+
:undoc-members:
63+
:show-inheritance:
64+

‎docs/source/api/zlock.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=====================
2+
labscript_utils.zlock
3+
=====================
4+
5+
.. automodule:: labscript_utils.zlock
6+
:members:
7+
:undoc-members:
8+
:private-members:

0 commit comments

Comments
 (0)