Skip to content
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

Reorganise API docs #1478

Merged
merged 28 commits into from
Mar 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
3b8aa3b
Add skeleton of dataset api
jenshnielsen Feb 15, 2019
052ce35
Doc all modules until math:
jenshnielsen Feb 15, 2019
f13352f
add api docs of most things
jenshnielsen Feb 15, 2019
2f17dc1
add utils
jenshnielsen Feb 15, 2019
d761bf0
Correct links
jenshnielsen Feb 15, 2019
1d930a3
Correct title
jenshnielsen Feb 18, 2019
b2565f5
Split instrument and parameter into two groups
jenshnielsen Feb 18, 2019
23ab333
Remove non needed special case and use non deprecated setting
jenshnielsen Feb 18, 2019
123552d
Disambiguate dataset links
jenshnielsen Feb 21, 2019
e553d12
Add legacy data docs to api docs
jenshnielsen Feb 21, 2019
1ed3182
add a short docstring to measurement module. Mainly as an example
jenshnielsen Mar 6, 2019
7e1cc9f
Cleanup Config and dataset
jenshnielsen Mar 6, 2019
280151c
Add api docs intro
jenshnielsen Mar 6, 2019
3cdf79e
Split dataset into subpages
jenshnielsen Mar 7, 2019
f1563f2
Split instrument into subpages
jenshnielsen Mar 7, 2019
f2f908a
Move instrument to subfolder
jenshnielsen Mar 7, 2019
4327b74
Split parameter into subpages
jenshnielsen Mar 7, 2019
57d22cd
Correct title
jenshnielsen Mar 7, 2019
1843065
Logger into subpages
jenshnielsen Mar 7, 2019
fa48947
Move rest of the main docs
jenshnielsen Mar 7, 2019
16d807d
Add zmq module
jenshnielsen Mar 7, 2019
0efc5fc
Split legacy files
jenshnielsen Mar 7, 2019
943ea8a
Add missing links
jenshnielsen Mar 7, 2019
55083c3
Include hidden tocs too
jenshnielsen Mar 7, 2019
508184a
remove whitespace
jenshnielsen Mar 7, 2019
97dde08
Unify summaries
jenshnielsen Mar 7, 2019
13ceffc
Remove slack from the summary
jenshnielsen Mar 7, 2019
f4638a1
remove a few entries
jenshnielsen Mar 7, 2019
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
5 changes: 5 additions & 0 deletions docs/api/actions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.actions
==============

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

.. automodule:: qcodes.config.config
:members:
19 changes: 19 additions & 0 deletions docs/api/config/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.. _config_api :

qcodes.config
=============

.. autosummary::

qcodes.config
qcodes.config.config


.. automodule:: qcodes.config


.. toctree::
:maxdepth: 4
:hidden:

config
5 changes: 5 additions & 0 deletions docs/api/data/data_array.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.data.data_array
----------------------

.. automodule:: qcodes.data.data_array
:members:
5 changes: 5 additions & 0 deletions docs/api/data/data_set.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.data.data_set
--------------------

.. automodule:: qcodes.data.data_set
:members:
5 changes: 5 additions & 0 deletions docs/api/data/format.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.data.format
------------------

.. automodule:: qcodes.data.format
:members:
5 changes: 5 additions & 0 deletions docs/api/data/gnuplot_format.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.data.gnuplot_format
--------------------------

.. automodule:: qcodes.data.gnuplot_format
:members:
5 changes: 5 additions & 0 deletions docs/api/data/hdf5_format.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.data.hdf5_format
-----------------------

.. automodule:: qcodes.data.hdf5_format
:members:
5 changes: 5 additions & 0 deletions docs/api/data/hdf5_format_hickle.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.data.hdf5_format_hickle
------------------------------

.. automodule:: qcodes.data.hdf5_format_hickle
:members:
33 changes: 33 additions & 0 deletions docs/api/data/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. _legacydata_api :

qcodes.data
===========

.. autosummary::

qcodes.data
qcodes.data.data_array
qcodes.data.data_set
qcodes.data.format
qcodes.data.gnuplot_format
qcodes.data.hdf5_format
qcodes.data.hdf5_format_hickle
qcodes.data.io
qcodes.data.location


.. automodule:: qcodes.data


.. toctree::
:maxdepth: 4
:hidden:

data_array
data_set
format
gnuplot_format
hdf5_format
hdf5_format_hickle
io
location
5 changes: 5 additions & 0 deletions docs/api/data/io.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.data.io
--------------

.. automodule:: qcodes.data.io
:members:
5 changes: 5 additions & 0 deletions docs/api/data/location.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.data.location
--------------------

.. automodule:: qcodes.data.location
:members:
5 changes: 5 additions & 0 deletions docs/api/dataset/data_set.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.dataset.data_set
-----------------------

.. automodule:: qcodes.dataset.data_set
:members:
5 changes: 5 additions & 0 deletions docs/api/dataset/database_extract_runs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.dataset.database_extract_runs
------------------------------------

.. automodule:: qcodes.dataset.database_extract_runs
:members:
28 changes: 28 additions & 0 deletions docs/api/dataset/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. _dataset_api :

qcodes.dataset
==============


.. autosummary::

qcodes.dataset
qcodes.dataset.measurements
qcodes.dataset.plotting
qcodes.dataset.data_set
qcodes.dataset.database_extract_runs
qcodes.dataset.legacy_import


.. automodule:: qcodes.dataset


.. toctree::
:maxdepth: 4
:hidden:

measurements
plotting
data_set
database_extract_runs
legacy_import
5 changes: 5 additions & 0 deletions docs/api/dataset/legacy_import.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.dataset.legacy_import
----------------------------

.. automodule:: qcodes.dataset.legacy_import
:members:
5 changes: 5 additions & 0 deletions docs/api/dataset/measurements.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.dataset.measurements
---------------------------

.. automodule:: qcodes.dataset.measurements
:members:
5 changes: 5 additions & 0 deletions docs/api/dataset/plotting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.dataset.plotting
-----------------------

.. automodule:: qcodes.dataset.plotting
:members:
37 changes: 30 additions & 7 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,40 @@
.. _Api :

Classes and Functions
=====================
QCoDes API documentation
========================

This page lists the entry points to the qcodes API.
This page documents the QCoDes API. This page contains documentation of all user facing modules.
A few of our modules are considered legacy and documented separately below.
This is split in roughly one page per QCoDeS submodule. A few of the submodules have been split for
additional clarity.

Public refers to what is available in qcodes namespace.

Private refers to everything that is available.
QCoDeS API
----------

.. toctree::
:maxdepth: 4
:includehidden:

public
private
config/index
dataset/index
instrument/index
parameters/index
logger/index
math/index
monitor/index
station
utils/index

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

.. toctree::
:maxdepth: 4
:includehidden:

loops
actions
measure
data/index
plots/index
5 changes: 5 additions & 0 deletions docs/api/instrument/base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.instrument.base
----------------------

.. automodule:: qcodes.instrument.base
:members:
5 changes: 5 additions & 0 deletions docs/api/instrument/channel.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.instrument.channel
-------------------------

.. automodule:: qcodes.instrument.channel
:members:
23 changes: 23 additions & 0 deletions docs/api/instrument/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. _instrument_api :

qcodes.instrument (Instruments)
===============================

.. autosummary::

qcodes.instrument
qcodes.instrument.visa
qcodes.instrument.channel
qcodes.instrument.base


.. automodule:: qcodes.instrument


.. toctree::
:maxdepth: 4
:hidden:

visa
channel
base
5 changes: 5 additions & 0 deletions docs/api/instrument/visa.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.instrument.visa
----------------------

.. automodule:: qcodes.instrument.visa
:members:
23 changes: 23 additions & 0 deletions docs/api/logger/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. _logger_api :

qcodes.logger
=============


.. autosummary::

qcodes.logger
qcodes.logger.instrument_logger
qcodes.logger.log_analysis
qcodes.logger.logger

.. automodule:: qcodes.logger


.. toctree::
:maxdepth: 4
:hidden:

instrument_logger
log_analysis
logger
5 changes: 5 additions & 0 deletions docs/api/logger/instrument_logger.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.logger.instrument_logger
-------------------------------

.. automodule:: qcodes.logger.instrument_logger
:members:
5 changes: 5 additions & 0 deletions docs/api/logger/log_analysis.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.logger.log_analysis
--------------------------

.. automodule:: qcodes.logger.log_analysis
:members:
5 changes: 5 additions & 0 deletions docs/api/logger/logger.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.logger.logger
--------------------

.. automodule:: qcodes.logger.logger
:members:
7 changes: 7 additions & 0 deletions docs/api/loops.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _loops_api :

qcodes.loops
============

.. automodule:: qcodes.loops
:members:
5 changes: 5 additions & 0 deletions docs/api/math/field_vector.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.math.field_vector
------------------------

.. automodule:: qcodes.math.field_vector
:members:
19 changes: 19 additions & 0 deletions docs/api/math/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.. _math_api :

qcodes.math
===========

.. autosummary::

qcodes.math
qcodes.math.field_vector


.. automodule:: qcodes.math


.. toctree::
:maxdepth: 4
:hidden:

field_vector
5 changes: 5 additions & 0 deletions docs/api/measure.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.measure
==============

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

qcodes.monitor
==============

.. autosummary::

qcodes.monitor
qcodes.monitor.monitor


.. automodule:: qcodes.monitor


.. toctree::
:maxdepth: 4
:hidden:

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

.. automodule:: qcodes.monitor.monitor
:members:
5 changes: 5 additions & 0 deletions docs/api/parameters/group_parameter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
qcodes.instrument.group_parameter
---------------------------------

.. automodule:: qcodes.instrument.group_parameter
:members:
Loading