Skip to content

Increasing API coverage for labscript_utils components. #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/source/api/connections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ labscript_utils.connections

.. automodule:: labscript_utils.connections
:members:
:undoc-members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/dict_diff.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=========================
labscript_utils.dict_diff
=========================

.. automodule:: labscript_utils.dict_diff
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/double_import_denier.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
====================================
labscript_utils.double_import_denier
====================================

.. automodule:: labscript_utils.double_import_denier
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/filewatcher.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
===========================
labscript_utils.filewatcher
===========================

.. automodule:: labscript_utils.filewatcher
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/h5_lock.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=======================
labscript_utils.h5_lock
=======================

.. automodule:: labscript_utils.h5_lock
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/impprof.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=======================
labscript_utils.impprof
=======================

.. automodule:: labscript_utils.impprof
:members:
:undoc-members:
:private-members:
55 changes: 54 additions & 1 deletion docs/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 8 additions & 0 deletions docs/source/api/labconfig.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=========================
labscript_utils.labconfig
=========================

.. automodule:: labscript_utils.labconfig
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/ls_zprocess.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
===========================
labscript_utils.ls_zprocess
===========================

.. automodule:: labscript_utils.ls_zprocess
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/memprof.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=======================
labscript_utils.memprof
=======================

.. automodule:: labscript_utils.memprof
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/modulewatcher.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=============================
labscript_utils.modulewatcher
=============================

.. automodule:: labscript_utils.modulewatcher
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/properties.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
==========================
labscript_utils.properties
==========================

.. automodule:: labscript_utils.properties
:members:
:undoc-members:
:private-members:
78 changes: 78 additions & 0 deletions docs/source/api/qtwidgets.rst
Original file line number Diff line number Diff line change
@@ -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:
8 changes: 8 additions & 0 deletions docs/source/api/remote.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
======================
labscript_utils.remote
======================

.. automodule:: labscript_utils.remote
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/settings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
========================
labscript_utils.settings
========================

.. automodule:: labscript_utils.settings
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/setup_logging.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=============================
labscript_utils.setup_logging
=============================

.. automodule:: labscript_utils.setup_logging
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/shared_drive.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
============================
labscript_utils.shared_drive
============================

.. automodule:: labscript_utils.shared_drive
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/splash.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
======================
labscript_utils.splash
======================

.. automodule:: labscript_utils.splash
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/testing_utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=============================
labscript_utils.testing_utils
=============================

.. automodule:: labscript_utils.testing_utils
:members:
:undoc-members:
:private-members:
8 changes: 8 additions & 0 deletions docs/source/api/tracelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
========================
labscript_utils.tracelog
========================

.. automodule:: labscript_utils.tracelog
:members:
:undoc-members:
:private-members:
64 changes: 64 additions & 0 deletions docs/source/api/unitconversions.rst
Original file line number Diff line number Diff line change
@@ -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:

8 changes: 8 additions & 0 deletions docs/source/api/zlock.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
=====================
labscript_utils.zlock
=====================

.. automodule:: labscript_utils.zlock
:members:
:undoc-members:
:private-members:
Loading