add utils

microsoft · Feb 18, 2019 · cc840d3 · cc840d3
1 parent 3ee3d65
commit cc840d3
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 0 deletions.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -16,6 +16,7 @@ QCoDeS API
    math
    monitor
    station
+   utils
 
 Legacy API
 ----------

diff --git a/docs/api/parameters.rst b/docs/api/parameters.rst
diff --git a/docs/api/utils.rst b/docs/api/utils.rst
@@ -0,0 +1,68 @@
+.. _utils_api :
+
+Parameter API
+=============
+
+TODO: Write some introduction about parameters.
+
+
+command
+-------
+
+.. automodule:: qcodes.utils.command
+   :members:
+
+
+deprecate
+---------
+
+.. automodule:: qcodes.utils.deprecate
+   :members:
+
+helpers
+-------
+
+.. automodule:: qcodes.utils.helpers
+   :members:
+
+magic
+-----
+
+.. automodule:: qcodes.utils.magic
+   :members:
+
+metadata
+--------
+
+.. automodule:: qcodes.utils.metadata
+   :members:
+
+plotting
+--------
+
+.. automodule:: qcodes.utils.plotting
+   :members:
+
+slack
+-----
+
+.. automodule:: qcodes.utils.slack
+   :members:
+
+threading
+---------
+
+.. automodule:: qcodes.utils.threading
+   :members:
+
+validators
+----------
+
+.. automodule:: qcodes.utils.validators
+   :members:
+
+zmq_helpers
+-----------
+
+.. automodule:: qcodes.utils.zmq_helpers
+   :members:
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ QCoDeS API @@
        math
        monitor
        station
+       utils
     Legacy API
     ----------
@@ Expand Down @@