diff --git a/docs/api/index.rst b/docs/api/index.rst index 434fb990de4f..fc8a95b6ba6c 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -1,7 +1,10 @@ .. _Api : +API DOCS +======== + QCoDeS API -========== +---------- .. toctree:: :maxdepth: 4 @@ -11,5 +14,14 @@ QCoDeS API instrument logger math + monitor + station + +Legacy API +---------- +.. toctree:: + :maxdepth: 4 + plots + loops diff --git a/docs/api/loops.rst b/docs/api/loops.rst new file mode 100644 index 000000000000..fec148f80783 --- /dev/null +++ b/docs/api/loops.rst @@ -0,0 +1,27 @@ +.. _loops_api : + +Loops +===== + +Loops API + + +Loops +----- + +.. automodule:: qcodes.loops + :members: + + +measure +------- + +.. automodule:: qcodes.measure + :members: + + +actions +------- + +.. automodule:: qcodes.actions + :members: \ No newline at end of file diff --git a/docs/api/monitor.rst b/docs/api/monitor.rst new file mode 100644 index 000000000000..17118ccc5c65 --- /dev/null +++ b/docs/api/monitor.rst @@ -0,0 +1,13 @@ +.. _monitor_api : + +Monitor +======= + +Monitor API + + +monitor +------- + +.. automodule:: qcodes.monitor.monitor + :members: diff --git a/docs/api/plots.rst b/docs/api/plots.rst new file mode 100644 index 000000000000..270560dcb104 --- /dev/null +++ b/docs/api/plots.rst @@ -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: \ No newline at end of file diff --git a/docs/api/station.rst b/docs/api/station.rst new file mode 100644 index 000000000000..bf7093f555e0 --- /dev/null +++ b/docs/api/station.rst @@ -0,0 +1,10 @@ +.. _station_api : + +Station +======= + +Station API + +.. automodule:: qcodes.station + :members: +