summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorRuben Undheim <ruben.undheim@gmail.com>2019-10-18 23:05:23 +0200
committerRuben Undheim <ruben.undheim@gmail.com>2019-10-18 23:05:23 +0200
commit62aeb2f4e73e449b4477b2d396bd3ffc7b31c575 (patch)
tree0a3a41d66e3100af0f431f5da6372983d9412d5b /docs/api
parent9c5924b696b7c9fa626464a294c5c235ed166bf8 (diff)
New upstream version 1.10.1
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/constants.rst45
-rw-r--r--docs/api/index.rst14
-rw-r--r--docs/api/resourcemanager.rst9
-rw-r--r--docs/api/resources.rst135
-rw-r--r--docs/api/visalibrarybase.rst9
5 files changed, 0 insertions, 212 deletions
diff --git a/docs/api/constants.rst b/docs/api/constants.rst
deleted file mode 100644
index 398ad1c..0000000
--- a/docs/api/constants.rst
+++ /dev/null
@@ -1,45 +0,0 @@
-.. _api_constants:
-
-Constants module
-----------------
-
-.. py:module:: pyvisa.constants
-
-Provides user-friendly naming to values used in different functions.
-
-
-.. autoclass:: AccessModes
- :members:
- :undoc-members:
-
-.. autoclass:: StopBits
- :members:
- :undoc-members:
-
-.. autoclass:: Parity
- :members:
- :undoc-members:
-
-.. autoclass:: SerialTermination
- :members:
- :undoc-members:
-
-.. autoclass:: InterfaceType
- :members:
- :undoc-members:
-
-.. autoclass:: AddressState
- :members:
- :undoc-members:
-
-.. autoclass:: IOProtocol
- :members:
- :undoc-members:
-
-.. autoclass:: LineState
- :members:
- :undoc-members:
-
-.. autoclass:: StatusCode
- :members:
- :undoc-members:
diff --git a/docs/api/index.rst b/docs/api/index.rst
deleted file mode 100644
index 88227de..0000000
--- a/docs/api/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-.. _api:
-
-===
-API
-===
-
-
-.. toctree::
- :maxdepth: 1
-
- visalibrarybase
- resourcemanager
- resources
- constants
diff --git a/docs/api/resourcemanager.rst b/docs/api/resourcemanager.rst
deleted file mode 100644
index a4cd468..0000000
--- a/docs/api/resourcemanager.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. _api_resourcemanager:
-
-Resource Manager
-----------------
-
-.. autoclass:: pyvisa.highlevel.ResourceInfo
-
-.. autoclass:: pyvisa.highlevel.ResourceManager
- :members: close, session, list_resources, list_resources_info, resource_info, open_bare_resource, open_resource, last_status
diff --git a/docs/api/resources.rst b/docs/api/resources.rst
deleted file mode 100644
index 54dd5bc..0000000
--- a/docs/api/resources.rst
+++ /dev/null
@@ -1,135 +0,0 @@
-.. _api_resources:
-
-Resource classes
-----------------
-
-Resources are high level abstractions to managing specific sessions. An instance
-of one of these classes is returned by the :meth:`~pyvisa.highlevel.ResourceManager.open_resource`
-depending on the resource type.
-
-Generic classes
-~~~~~~~~~~~~~~~
-
- - :class:`~pyvisa.resources.Resource`
- - :class:`~pyvisa.resources.MessageBasedResource`
- - :class:`~pyvisa.resources.RegisterBasedResource`
-
-
-Specific Classes
-~~~~~~~~~~~~~~~~
-
- - :class:`~pyvisa.resources.SerialInstrument`
- - :class:`~pyvisa.resources.TCPIPInstrument`
- - :class:`~pyvisa.resources.TCPIPSocket`
- - :class:`~pyvisa.resources.USBInstrument`
- - :class:`~pyvisa.resources.USBRaw`
- - :class:`~pyvisa.resources.GPIBInstrument`
- - :class:`~pyvisa.resources.GPIBInterface`
- - :class:`~pyvisa.resources.FirewireInstrument`
- - :class:`~pyvisa.resources.PXIInstrument`
- - :class:`~pyvisa.resources.PXIInstrument`
- - :class:`~pyvisa.resources.VXIInstrument`
- - :class:`~pyvisa.resources.VXIMemory`
- - :class:`~pyvisa.resources.VXIBackplane`
-
-.. currentmodule::`pyvisa.resources`
-
-
-.. autoclass:: pyvisa.resources.Resource
- :members:
- :inherited-members:
- :undoc-members:
-
-
-.. autoclass:: pyvisa.resources.MessageBasedResource
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-
-.. autoclass:: pyvisa.resources.RegisterBasedResource
- :members:
- :inherited-members:
- :undoc-members:
-
-
-.. autoclass:: pyvisa.resources.SerialInstrument
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-
-.. autoclass:: pyvisa.resources.TCPIPInstrument
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.TCPIPSocket
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.USBInstrument
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.USBRaw
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.GPIBInstrument
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.GPIBInterface
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.FirewireInstrument
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.PXIInstrument
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.PXIMemory
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.VXIInstrument
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.VXIMemory
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
-.. autoclass:: pyvisa.resources.VXIBackplane
- :members:
- :inherited-members:
- :exclude-members: ask_delay, ask_for_values, ask
- :undoc-members:
-
diff --git a/docs/api/visalibrarybase.rst b/docs/api/visalibrarybase.rst
deleted file mode 100644
index df8a24d..0000000
--- a/docs/api/visalibrarybase.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. _api_visalibrarybase:
-
-
-Visa Library
-------------
-
-.. autoclass:: pyvisa.highlevel.VisaLibraryBase
- :members:
-