Fix documentation inheriting Instrument and CommonBase documentation (p…

…ymeasure#903) * For instruments that inherit a base class, don't inherit Instrument class. If not inheriting a class, remove ':inherited-members:'. * Move KeithleyBuffer mixin to start of class method resolution order. * Blocked CommonBase, pass through Instrument * Change `:inherited-members: Instrument` to `:inherited-members: CommonBase` to include Instrument documentation
DEMCON · Jul 20, 2023 · 6ff994e · 6ff994e
1 parent f6e2c13
commit 6ff994e
Show file tree

Hide file tree

Showing 29 changed files with 33 additions and 49 deletions.
diff --git a/docs/api/instruments/andeenhagerling/ah2700a.rst b/docs/api/instruments/andeenhagerling/ah2700a.rst
@@ -5,4 +5,4 @@ Andeen Hagerling AH2700A capacitance bridge
 .. autoclass:: pymeasure.instruments.andeenhagerling.AH2700A
     :members:
     :show-inheritance:
-    :inherited-members: Instrument
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/eurotest/eurotestHPP120256.rst b/docs/api/instruments/eurotest/eurotestHPP120256.rst
@@ -5,5 +5,3 @@ Euro Test HPP120256 High Voltage Power Supply
 .. autoclass:: pymeasure.instruments.eurotest.EurotestHPP120256
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
diff --git a/docs/api/instruments/fwbell/fwbell5080.rst b/docs/api/instruments/fwbell/fwbell5080.rst
@@ -4,4 +4,5 @@ F.W. Bell 5080 Handheld Gaussmeter
 
 .. autoclass:: pymeasure.instruments.fwbell.FWBell5080
     :members:
-    :show-inheritance:
+    :show-inheritance:
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley2000.rst b/docs/api/instruments/keithley/keithley2000.rst
@@ -5,5 +5,4 @@ Keithley 2000 Multimeter
 .. autoclass:: pymeasure.instruments.keithley.Keithley2000
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley2260B.rst b/docs/api/instruments/keithley/keithley2260B.rst
@@ -5,5 +5,4 @@ Keithley 2260B DC Power Supply
 .. autoclass:: pymeasure.instruments.keithley.Keithley2260B
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley2306.rst b/docs/api/instruments/keithley/keithley2306.rst
@@ -5,5 +5,4 @@ Keithley 2306 Dual Channel Battery/Charger Simulator
 .. autoclass:: pymeasure.instruments.keithley.Keithley2306
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley2400.rst b/docs/api/instruments/keithley/keithley2400.rst
@@ -5,5 +5,4 @@ Keithley 2400 SourceMeter
 .. autoclass:: pymeasure.instruments.keithley.Keithley2400
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley2450.rst b/docs/api/instruments/keithley/keithley2450.rst
@@ -5,5 +5,4 @@ Keithley 2450 SourceMeter
 .. autoclass:: pymeasure.instruments.keithley.Keithley2450
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley2600.rst b/docs/api/instruments/keithley/keithley2600.rst
@@ -5,5 +5,4 @@ Keithley 2600 SourceMeter
 .. autoclass:: pymeasure.instruments.keithley.Keithley2600
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley2700.rst b/docs/api/instruments/keithley/keithley2700.rst
@@ -5,5 +5,4 @@ Keithley 2700 MultiMeter/Switch System
 .. autoclass:: pymeasure.instruments.keithley.Keithley2700
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley2750.rst b/docs/api/instruments/keithley/keithley2750.rst
@@ -5,5 +5,4 @@ Keithley 2750 Multimeter/Switch System
 .. autoclass:: pymeasure.instruments.keithley.Keithley2750
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley6221.rst b/docs/api/instruments/keithley/keithley6221.rst
@@ -5,5 +5,4 @@ Keithley 6221 AC and DC Current Source
 .. autoclass:: pymeasure.instruments.keithley.Keithley6221
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keithley/keithley6517b.rst b/docs/api/instruments/keithley/keithley6517b.rst
@@ -5,5 +5,4 @@ Keithley 6517B Electrometer
 .. autoclass:: pymeasure.instruments.keithley.Keithley6517B
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, extract_value, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/keysight/keysightDSOX1102G.rst b/docs/api/instruments/keysight/keysightDSOX1102G.rst
@@ -5,5 +5,3 @@ Keysight DSOX1102G Oscilloscope
 .. autoclass:: pymeasure.instruments.keysight.KeysightDSOX1102G
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members:
diff --git a/docs/api/instruments/keysight/keysightN5767A.rst b/docs/api/instruments/keysight/keysightN5767A.rst
@@ -5,5 +5,3 @@ Keysight N5767A Power Supply
 .. autoclass:: pymeasure.instruments.keysight.KeysightN5767A
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
diff --git a/docs/api/instruments/keysight/keysightN7776C.rst b/docs/api/instruments/keysight/keysightN7776C.rst
@@ -1,9 +1,7 @@
 ############################
-Keysight N5767A Power Supply
+Keysight N5776C Power Supply
 ############################
 
 .. autoclass:: pymeasure.instruments.keysight.KeysightN7776C
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
diff --git a/docs/api/instruments/lecroy/lecroyT3DSO1204.rst b/docs/api/instruments/lecroy/lecroyT3DSO1204.rst
@@ -11,3 +11,4 @@ LeCroy T3DSO1204 Oscilloscope
 .. autoclass:: pymeasure.instruments.lecroy.lecroyT3DSO1204.ScopeChannel
     :members:
     :show-inheritance:
+
diff --git a/docs/api/instruments/signalrecovery/dsp7225.rst b/docs/api/instruments/signalrecovery/dsp7225.rst
@@ -5,4 +5,4 @@ DSP 7225 Lock-in Amplifier
 .. autoclass:: pymeasure.instruments.signalrecovery.DSP7225
     :members:
     :show-inheritance:
-    :inherited-members: Instrument
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/signalrecovery/dsp7265.rst b/docs/api/instruments/signalrecovery/dsp7265.rst
@@ -5,4 +5,4 @@ DSP 7265 Lock-in Amplifier
 .. autoclass:: pymeasure.instruments.signalrecovery.DSP7265
     :members:
     :show-inheritance:
-    :inherited-members: Instrument
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/tdk/tdk_gen40_38.rst b/docs/api/instruments/tdk/tdk_gen40_38.rst
@@ -5,4 +5,4 @@ TDK Lambda Genesys 40-38 DC power supply
 .. autoclass:: pymeasure.instruments.tdk.tdk_gen40_38.TDK_Gen40_38
     :members:
     :show-inheritance:
-    :inherited-members: Instrument
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/tdk/tdk_gen80_65.rst b/docs/api/instruments/tdk/tdk_gen80_65.rst
@@ -5,4 +5,4 @@ TDK Lambda Genesys 80-65 DC power supply
 .. autoclass:: pymeasure.instruments.tdk.tdk_gen80_65.TDK_Gen80_65
     :members:
     :show-inheritance:
-    :inherited-members: Instrument
+    :inherited-members: CommonBase
diff --git a/docs/api/instruments/teledyne/teledyneT3AFG.rst b/docs/api/instruments/teledyne/teledyneT3AFG.rst
@@ -5,8 +5,9 @@ Teledyne T3AFG Arbitrary Waveform Generator
 .. autoclass:: pymeasure.instruments.teledyne.TeledyneT3AFG
     :members:
     :show-inheritance:
-    :inherited-members:
+    :inherited-members: CommonBase
 
 .. autoclass:: pymeasure.instruments.teledyne.teledyneT3AFG.SignalChannel
     :members:
     :show-inheritance:
+
diff --git a/docs/api/instruments/texio/texioPSW360L30.rst b/docs/api/instruments/texio/texioPSW360L30.rst
@@ -5,5 +5,4 @@ TEXIO PSW-360L30 Power Supply
 .. autoclass:: pymeasure.instruments.texio.TexioPSW360L30
     :members:
     :show-inheritance:
-    :inherited-members:
-    :exclude-members: ask, control, clear, measurement, read, setting, values, write
+    :inherited-members: CommonBase
diff --git a/pymeasure/instruments/keithley/keithley2000.py b/pymeasure/instruments/keithley/keithley2000.py
@@ -35,7 +35,7 @@
 log.addHandler(logging.NullHandler())
 
 
-class Keithley2000(Instrument, KeithleyBuffer):
+class Keithley2000(KeithleyBuffer, Instrument):
     """ Represents the Keithley 2000 Multimeter and provides a high-level
     interface for interacting with the instrument.
 

diff --git a/pymeasure/instruments/keithley/keithley2400.py b/pymeasure/instruments/keithley/keithley2400.py
@@ -37,8 +37,8 @@
 log.addHandler(logging.NullHandler())
 
 
-class Keithley2400(Instrument, KeithleyBuffer):
-    """ Represents the Keithely 2400 SourceMeter and provides a
+class Keithley2400(KeithleyBuffer, Instrument):
+    """ Represents the Keithley 2400 SourceMeter and provides a
     high-level interface for interacting with the instrument.
 
     .. code-block:: python

diff --git a/pymeasure/instruments/keithley/keithley2450.py b/pymeasure/instruments/keithley/keithley2450.py
@@ -36,8 +36,8 @@
 log.addHandler(logging.NullHandler())
 
 
-class Keithley2450(Instrument, KeithleyBuffer):
-    """ Represents the Keithely 2450 SourceMeter and provides a
+class Keithley2450(KeithleyBuffer, Instrument):
+    """ Represents the Keithley 2450 SourceMeter and provides a
     high-level interface for interacting with the instrument.
 
     .. code-block:: python

diff --git a/pymeasure/instruments/keithley/keithley2700.py b/pymeasure/instruments/keithley/keithley2700.py
@@ -86,8 +86,8 @@ def text_length_validator(value, values):
     return value[:values]
 
 
-class Keithley2700(Instrument, KeithleyBuffer):
-    """ Represents the Keithely 2700 Multimeter/Switch System and provides a
+class Keithley2700(KeithleyBuffer, Instrument):
+    """ Represents the Keithley 2700 Multimeter/Switch System and provides a
     high-level interface for interacting with the instrument.
 
     .. code-block:: python

diff --git a/pymeasure/instruments/keithley/keithley6221.py b/pymeasure/instruments/keithley/keithley6221.py
@@ -36,8 +36,8 @@
 log.addHandler(logging.NullHandler())
 
 
-class Keithley6221(Instrument, KeithleyBuffer):
-    """ Represents the Keithely 6221 AC and DC current source and provides a
+class Keithley6221(KeithleyBuffer, Instrument):
+    """ Represents the Keithley 6221 AC and DC current source and provides a
     high-level interface for interacting with the instrument.
 
     .. code-block:: python

diff --git a/pymeasure/instruments/keithley/keithley6517b.py b/pymeasure/instruments/keithley/keithley6517b.py
@@ -36,8 +36,8 @@
 log.addHandler(logging.NullHandler())
 
 
-class Keithley6517B(Instrument, KeithleyBuffer):
-    """ Represents the Keithely 6517B ElectroMeter and provides a
+class Keithley6517B(KeithleyBuffer, Instrument):
+    """ Represents the Keithley 6517B ElectroMeter and provides a
     high-level interface for interacting with the instrument.
 
     .. code-block:: python