Skip to content

Commit

Permalink
add api docs of most things
Browse files Browse the repository at this point in the history
  • Loading branch information
jenshnielsen committed Feb 18, 2019
1 parent ca28f76 commit 3ee3d65
Show file tree
Hide file tree
Showing 5 changed files with 97 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/api/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
.. _Api :

API DOCS
========

QCoDeS API
==========
----------

.. toctree::
:maxdepth: 4
Expand All @@ -11,5 +14,14 @@ QCoDeS API
instrument
logger
math
monitor
station

Legacy API
----------

.. toctree::
:maxdepth: 4

plots
loops
27 changes: 27 additions & 0 deletions docs/api/loops.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _loops_api :

Loops
=====

Loops API


Loops
-----

.. automodule:: qcodes.loops
:members:


measure
-------

.. automodule:: qcodes.measure
:members:


actions
-------

.. automodule:: qcodes.actions
:members:
13 changes: 13 additions & 0 deletions docs/api/monitor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. _monitor_api :

Monitor
=======

Monitor API


monitor
-------

.. automodule:: qcodes.monitor.monitor
:members:
34 changes: 34 additions & 0 deletions docs/api/plots.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _plots_api :

Plots
=====

Plots API


base
----

.. automodule:: qcodes.plots.base
:members:


colors
------

.. automodule:: qcodes.plots.colors
:members:


pyqtgraph
---------

.. automodule:: qcodes.plots.pyqtgraph
:members:


qcmatplotlib
------------

.. automodule:: qcodes.plots.qcmatplotlib
:members:
10 changes: 10 additions & 0 deletions docs/api/station.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _station_api :

Station
=======

Station API

.. automodule:: qcodes.station
:members:

0 comments on commit 3ee3d65

Please sign in to comment.