Generated gh-pages for commit 41530ba

Author: Jens Hedegaard Nielsen <jenshnielsen@gmail.com>

    Fix a number of rst issues (#742)

_modules/qcodes/instrument_drivers/oxford/ILM200.html

@@ -197,13 +197,12 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Initializes the Oxford Instruments ILM 200 Helium Level Meter.</span>
 
-<span class="sd">        Input:</span>
-<span class="sd">            name (string)    : name of the instrument</span>
-<span class="sd">            address (string) : instrument address</span>
-<span class="sd">            number (int)     : ISOBUS instrument number</span>
-<span class="sd">                                                           (number=1 is specific to the ILM in F008)</span>
+<span class="sd">        Args:</span>
+<span class="sd">            name (string): name of the instrument</span>
+<span class="sd">            address (string): instrument address</span>
+<span class="sd">            number (int): ISOBUS instrument number (number=1 is specific to the ILM in F008)</span>
 
-<span class="sd">        Output:</span>
+<span class="sd">        Returns:</span>
 <span class="sd">            None</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">logging</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s1">&#39; : Initializing instrument&#39;</span><span class="p">)</span>
@@ -238,10 +237,10 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
 <span class="sd">        Write a command to the device and read answer. This function writes to</span>
 <span class="sd">        the buffer by adding the device number at the front, instead of &#39;ask&#39;.</span>
 
-<span class="sd">        Input:</span>
+<span class="sd">        Args:</span>
 <span class="sd">            message (str) : write command for the device</span>
 
-<span class="sd">        Output:</span>
+<span class="sd">        Returns:</span>
 <span class="sd">            None</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
@@ -258,10 +257,10 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Reads the total bytes in the buffer and outputs as a string.</span>
 
-<span class="sd">        Input:</span>
+<span class="sd">        Args:</span>
 <span class="sd">            None</span>
 
-<span class="sd">        Output:</span>
+<span class="sd">        Returns:</span>
 <span class="sd">            message (str)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="c1"># because protocol has no termination chars the read reads the number</span>
@@ -277,7 +276,7 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
 
 <div class="viewcode-block" id="OxfordInstruments_ILM200.get_idn"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.oxford.html#qcodes.instrument_drivers.oxford.ILM200.OxfordInstruments_ILM200.get_idn">[docs]</a>    <span class="k">def</span> <span class="nf">get_idn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Overides the function of Instrument since ILM does not support &#39;*IDN?&#39;</span>
+<span class="sd">        Overrides the function of Instrument since ILM does not support `*IDN?`</span>
 
 <span class="sd">        This string is supposed to be a</span>
 <span class="sd">        comma-separated list of vendor, model, serial, and firmware, but</span>
@@ -308,12 +307,6 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Reads all implemented parameters from the instrument,</span>
 <span class="sd">        and updates the wrapper.</span>
-
-<span class="sd">        Args:</span>
-<span class="sd">            None</span>
-
-<span class="sd">        Returns:</span>
-<span class="sd">            None</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s1">&#39; : reading all settings from instrument&#39;</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">level</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
@@ -336,7 +329,7 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
 <span class="sd">        Args:</span>
 <span class="sd">            None</span>
 
-<span class="sd">        Return:</span>
+<span class="sd">        Returns:</span>
 <span class="sd">            identification (str): should be &#39;ILM200 Version 1.08 (c) OXFORD 1994\r&#39;</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s1">&#39; : Identify the device&#39;</span><span class="p">)</span>
@@ -345,7 +338,8 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
     <span class="k">def</span> <span class="nf">_do_get_level</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Get Helium level of channel 1.</span>
-<span class="sd">        Input:</span>
+
+<span class="sd">        Args:</span>
 <span class="sd">            None</span>
 
 <span class="sd">        Returns:</span>
@@ -358,11 +352,6 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
     <span class="k">def</span> <span class="nf">_do_get_status</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Get status of the device.</span>
-<span class="sd">        Input:</span>
-<span class="sd">            None</span>
-
-<span class="sd">        Returns:</span>
-<span class="sd">            None</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s1">&#39; : Get status of the device.&#39;</span><span class="p">)</span>
         <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_execute</span><span class="p">(</span><span class="s1">&#39;X&#39;</span><span class="p">)</span>
@@ -407,25 +396,13 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
 <div class="viewcode-block" id="OxfordInstruments_ILM200.remote"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.oxford.html#qcodes.instrument_drivers.oxford.ILM200.OxfordInstruments_ILM200.remote">[docs]</a>    <span class="k">def</span> <span class="nf">remote</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Set control to remote &amp; locked</span>
-
-<span class="sd">        Input:</span>
-<span class="sd">            None</span>
-
-<span class="sd">        Output:</span>
-<span class="sd">            None</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s1">&#39; : Set control to remote &amp; locked&#39;</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">set_remote_status</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span></div>
 
 <div class="viewcode-block" id="OxfordInstruments_ILM200.local"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.oxford.html#qcodes.instrument_drivers.oxford.ILM200.OxfordInstruments_ILM200.local">[docs]</a>    <span class="k">def</span> <span class="nf">local</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Set control to local &amp; locked</span>
-
-<span class="sd">        Input:</span>
-<span class="sd">            None</span>
-
-<span class="sd">        Output:</span>
-<span class="sd">            None</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s1">&#39; : Set control to local &amp; locked&#39;</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">set_remote_status</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span></div>
@@ -434,14 +411,14 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Set remote control status.</span>
 
-<span class="sd">        Input:</span>
+<span class="sd">        Args:</span>
 <span class="sd">            mode(int) :</span>
 <span class="sd">            0 : &quot;Local and locked&quot;,</span>
 <span class="sd">            1 : &quot;Remote and locked&quot;,</span>
 <span class="sd">            2 : &quot;Local and unlocked&quot;,</span>
 <span class="sd">            3 : &quot;Remote and unlocked&quot;,</span>
 
-<span class="sd">        Output:</span>
+<span class="sd">        Returns:</span>
 <span class="sd">            None</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">status</span> <span class="o">=</span> <span class="p">{</span>
@@ -477,7 +454,7 @@ <h1>Source code for qcodes.instrument_drivers.oxford.ILM200</h1><div class="high
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Set helium meter channel 1 probe rate</span>
 
-<span class="sd">        Input:</span>
+<span class="sd">        Args:</span>
 <span class="sd">            rate(int) :</span>
 <span class="sd">            0 : &quot;SLOW&quot;</span>
 <span class="sd">            1 : &quot;FAST&quot;</span>

_modules/qcodes/instrument_drivers/oxford/IPS120.html

@@ -401,7 +401,7 @@ <h1>Source code for qcodes.instrument_drivers.oxford.IPS120</h1><div class="high
 
 <div class="viewcode-block" id="OxfordInstruments_IPS120.get_idn"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.oxford.html#qcodes.instrument_drivers.oxford.IPS120.OxfordInstruments_IPS120.get_idn">[docs]</a>    <span class="k">def</span> <span class="nf">get_idn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Overides the function of Instrument since IPS120 does not support &#39;*IDN?&#39;</span>
+<span class="sd">        Overides the function of Instrument since IPS120 does not support `*IDN?`</span>
 
 <span class="sd">        This string is supposed to be a comma-separated list of vendor, model,</span>
 <span class="sd">        serial, and firmware, but semicolon and colon are also common</span>

_modules/qcodes/instrument_drivers/oxford/kelvinox.html

@@ -333,7 +333,9 @@ <h1>Source code for qcodes.instrument_drivers.oxford.kelvinox</h1><div class="hi
 <div class="viewcode-block" id="OxfordInstruments_Kelvinox_IGH.identify"><a class="viewcode-back" href="../../../../api/generated/qcodes.instrument_drivers.oxford.html#qcodes.instrument_drivers.oxford.kelvinox.OxfordInstruments_Kelvinox_IGH.identify">[docs]</a>    <span class="k">def</span> <span class="nf">identify</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Identify the device</span>
 
-<span class="sd">        Returns a string of the form `&#39;IGH    Version 3.02 (c) OXFORD 1998\r&#39;`</span>
+<span class="sd">        Returns:</span>
+<span class="sd">             a string of the form ``&#39;IGH    Version 3.02 (c) OXFORD 1998\\r&#39;``</span>
+
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Identify the device&#39;</span><span class="p">)</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_execute</span><span class="p">(</span><span class="s1">&#39;V&#39;</span><span class="p">)</span></div>

_modules/qcodes/instrument_drivers/stanford_research/SR830.html

@@ -177,7 +177,7 @@ <h1>Source code for qcodes.instrument_drivers.stanford_research.SR830</h1><div c
 
 <span class="sd">    Currently always returns the entire buffer</span>
 <span class="sd">    TODO (WilliamHPNielsen): Make it possible to query parts of the buffer.</span>
-<span class="sd">        The instrument natively supports this in its TRCL call.</span>
+<span class="sd">    The instrument natively supports this in its TRCL call.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">instrument</span><span class="p">:</span> <span class="s1">&#39;SR830&#39;</span><span class="p">,</span> <span class="n">channel</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>

_notebooks/driver_examples/Keithley_example.html

@@ -109,6 +109,7 @@
 </li>
 <li class="toctree-l3"><a class="reference internal" href="QCodes example with SR830.html">QCoDeS example with SR830</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example ATS_ONWORK.html">Qcodes example ATS_ONWORK</a></li>
+<li class="toctree-l3"><a class="reference internal" href="Qcodes example with AMI430.html">QCoDeS example with AMI430</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example with Agilent 34400A.html">Qcodes example with Agilent 34400A</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example with Decadac.html">Qcodes example with Decadac</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example with Ithaco.html">Qcodes example with Ithaco</a></li>

_notebooks/driver_examples/QCodes example with SR830.html

@@ -110,6 +110,7 @@
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example ATS_ONWORK.html">Qcodes example ATS_ONWORK</a></li>
+<li class="toctree-l3"><a class="reference internal" href="Qcodes example with AMI430.html">QCoDeS example with AMI430</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example with Agilent 34400A.html">Qcodes example with Agilent 34400A</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example with Decadac.html">Qcodes example with Decadac</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example with Ithaco.html">Qcodes example with Ithaco</a></li>

_notebooks/driver_examples/Qcodes example ATS_ONWORK.html

@@ -37,7 +37,7 @@
         <link rel="search" title="Search" href="../../search.html"/>
     <link rel="top" title="QCoDeS 0.1.7 documentation" href="../../index.html"/>
         <link rel="up" title="Examples of using QCoDeS" href="../../examples/index.html"/>
-        <link rel="next" title="&lt;no title&gt;" href="Qcodes example with AMI430.html"/>
+        <link rel="next" title="QCoDeS example with AMI430" href="Qcodes example with AMI430.html"/>
         <link rel="prev" title="QCoDeS example with SR830" href="QCodes example with SR830.html"/> 
 
 
@@ -106,6 +106,7 @@
 <li class="toctree-l3"><a class="reference internal" href="Keithley_example.html">Example script for Keithley driver</a></li>
 <li class="toctree-l3"><a class="reference internal" href="QCodes example with SR830.html">QCoDeS example with SR830</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">Qcodes example ATS_ONWORK</a></li>
+<li class="toctree-l3"><a class="reference internal" href="Qcodes example with AMI430.html">QCoDeS example with AMI430</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example with Agilent 34400A.html">Qcodes example with Agilent 34400A</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example with Decadac.html">Qcodes example with Decadac</a></li>
 <li class="toctree-l3"><a class="reference internal" href="Qcodes example with Ithaco.html">Qcodes example with Ithaco</a></li>
@@ -675,7 +676,7 @@ <h1>Qcodes example ATS_ONWORK<a class="headerlink" href="#qcodes-example-ats-onw
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="Qcodes example with AMI430.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="Qcodes example with AMI430.html" class="btn btn-neutral float-right" title="QCoDeS example with AMI430" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="QCodes example with SR830.html" class="btn btn-neutral" title="QCoDeS example with SR830" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>