Merge pull request #115 from PyCOMPLETE/develop

Updated sphinx doc

Author: giadarol

docs/PyHEADTAIL.aperture.html

@@ -708,7 +708,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2019, Author.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
     </div>
   </body>
 </html>

docs/PyHEADTAIL.cobra_functions.html

@@ -323,7 +323,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2019, Author.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
     </div>
   </body>
 </html>

docs/PyHEADTAIL.feedback.html

@@ -356,7 +356,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2019, Author.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
     </div>
   </body>
 </html>

docs/PyHEADTAIL.field_maps.html

@@ -48,50 +48,8 @@ <h3>Navigation</h3>
 <div class="section" id="submodules">
 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
 </div>
-<div class="section" id="module-PyHEADTAIL.field_maps.Transverse_Efield_map">
-<span id="pyheadtail-field-maps-transverse-efield-map-module"></span><h2>PyHEADTAIL.field_maps.Transverse_Efield_map module<a class="headerlink" href="#module-PyHEADTAIL.field_maps.Transverse_Efield_map" title="Permalink to this headline">¶</a></h2>
-<dl class="class">
-<dt id="PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map">
-<em class="property">class </em><code class="sig-prename descclassname">PyHEADTAIL.field_maps.Transverse_Efield_map.</code><code class="sig-name descname">Transverse_Efield_map</code><span class="sig-paren">(</span><em class="sig-param">xg</em>, <em class="sig-param">yg</em>, <em class="sig-param">Ex</em>, <em class="sig-param">Ey</em>, <em class="sig-param">L_interaction</em>, <em class="sig-param">slicer</em>, <em class="sig-param">flag_clean_slices=False</em>, <em class="sig-param">wrt_slice_centroid=False</em>, <em class="sig-param">x_beam_offset=0.0</em>, <em class="sig-param">y_beam_offset=0.0</em>, <em class="sig-param">verbose=False</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map" title="Permalink to this definition">¶</a></dt>
-<dd><dl class="attribute">
-<dt id="PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.__abstractmethods__">
-<code class="sig-name descname">__abstractmethods__</code><em class="property"> = frozenset({})</em><a class="headerlink" href="#PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.__abstractmethods__" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.__init__">
-<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">xg</em>, <em class="sig-param">yg</em>, <em class="sig-param">Ex</em>, <em class="sig-param">Ey</em>, <em class="sig-param">L_interaction</em>, <em class="sig-param">slicer</em>, <em class="sig-param">flag_clean_slices=False</em>, <em class="sig-param">wrt_slice_centroid=False</em>, <em class="sig-param">x_beam_offset=0.0</em>, <em class="sig-param">y_beam_offset=0.0</em>, <em class="sig-param">verbose=False</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.__init__" title="Permalink to this definition">¶</a></dt>
-<dd><p>Initialize self.  See help(type(self)) for accurate signature.</p>
-</dd></dl>
-
-<dl class="attribute">
-<dt id="PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.__module__">
-<code class="sig-name descname">__module__</code><em class="property"> = 'PyHEADTAIL.field_maps.Transverse_Efield_map'</em><a class="headerlink" href="#PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.__module__" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="attribute">
-<dt id="PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map._abc_impl">
-<code class="sig-name descname">_abc_impl</code><em class="property"> = &lt;_abc_data object&gt;</em><a class="headerlink" href="#PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map._abc_impl" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.get_beam_x">
-<code class="sig-name descname">get_beam_x</code><span class="sig-paren">(</span><em class="sig-param">beam</em><span class="sig-paren">)</span><a class="headerlink" href="#PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.get_beam_x" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.get_beam_y">
-<code class="sig-name descname">get_beam_y</code><span class="sig-paren">(</span><em class="sig-param">beam</em><span class="sig-paren">)</span><a class="headerlink" href="#PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.get_beam_y" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="method">
-<dt id="PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.track">
-<code class="sig-name descname">track</code><span class="sig-paren">(</span><em class="sig-param">beam</em><span class="sig-paren">)</span><a class="headerlink" href="#PyHEADTAIL.field_maps.Transverse_Efield_map.Transverse_Efield_map.track" title="Permalink to this definition">¶</a></dt>
-<dd><p>Perform tracking of beam through this Element.</p>
-</dd></dl>
-
-</dd></dl>
-
+<div class="section" id="pyheadtail-field-maps-transverse-efield-map-module">
+<h2>PyHEADTAIL.field_maps.Transverse_Efield_map module<a class="headerlink" href="#pyheadtail-field-maps-transverse-efield-map-module" title="Permalink to this headline">¶</a></h2>
 </div>
 <div class="section" id="pyheadtail-field-maps-field-map-module">
 <h2>PyHEADTAIL.field_maps.field_map module<a class="headerlink" href="#pyheadtail-field-maps-field-map-module" title="Permalink to this headline">¶</a></h2>
@@ -108,7 +66,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">PyHEADTAIL.field_maps package</a><ul>
 <li><a class="reference internal" href="#submodules">Submodules</a></li>
-<li><a class="reference internal" href="#module-PyHEADTAIL.field_maps.Transverse_Efield_map">PyHEADTAIL.field_maps.Transverse_Efield_map module</a></li>
+<li><a class="reference internal" href="#pyheadtail-field-maps-transverse-efield-map-module">PyHEADTAIL.field_maps.Transverse_Efield_map module</a></li>
 <li><a class="reference internal" href="#pyheadtail-field-maps-field-map-module">PyHEADTAIL.field_maps.field_map module</a></li>
 </ul>
 </li>
@@ -162,7 +120,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2019, Author.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
     </div>
   </body>
 </html>

docs/PyHEADTAIL.general.html

@@ -256,11 +256,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <em class="property">class </em><code class="sig-prename descclassname">PyHEADTAIL.general.element.</code><code class="sig-name descname">Printing</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#PyHEADTAIL.general.element.Printing" title="Permalink to this definition">¶</a></dt>
 <dd><p>Provides prints(output) method in order to communicate any output
 to the user. Use for instance</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="bp">self</span><span class="o">.</span><span class="n">prints</span><span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="bp">self</span><span class="o">.</span><span class="n">prints</span><span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>instead of</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>in order to obtain full flexibility over output channels.</p>
@@ -301,11 +301,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dt id="PyHEADTAIL.general.element.Printing.prints">
 <code class="sig-name descname">prints</code><span class="sig-paren">(</span><em class="sig-param">output</em><span class="sig-paren">)</span><a class="headerlink" href="#PyHEADTAIL.general.element.Printing.prints" title="Permalink to this definition">¶</a></dt>
 <dd><p>Communicate any output to the user. Use for instance</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="bp">self</span><span class="o">.</span><span class="n">prints</span><span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="bp">self</span><span class="o">.</span><span class="n">prints</span><span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>instead of</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>in order to obtain full flexibility over output channels.</p>
@@ -315,11 +315,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dt id="PyHEADTAIL.general.element.Printing.warns">
 <code class="sig-name descname">warns</code><span class="sig-paren">(</span><em class="sig-param">output</em><span class="sig-paren">)</span><a class="headerlink" href="#PyHEADTAIL.general.element.Printing.warns" title="Permalink to this definition">¶</a></dt>
 <dd><p>Communicate warnings to the user. Use for instance</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="bp">self</span><span class="o">.</span><span class="n">warns</span><span class="p">(</span><span class="s2">&quot;Example warning to console.&quot;</span><span class="p">)</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="bp">self</span><span class="o">.</span><span class="n">warns</span><span class="p">(</span><span class="s2">&quot;Example warning to console.&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>instead of</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="s2">&quot;Example message to console.&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 </dd></dl>
@@ -602,7 +602,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dt id="PyHEADTAIL.general.printers.ConsolePrinter">
 <em class="property">class </em><code class="sig-prename descclassname">PyHEADTAIL.general.printers.</code><code class="sig-name descname">ConsolePrinter</code><a class="headerlink" href="#PyHEADTAIL.general.printers.ConsolePrinter" title="Permalink to this definition">¶</a></dt>
 <dd><p>Redirects to console, equivalent to the print statement</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="n">output</span><span class="p">)</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="n">output</span><span class="p">)</span>
 </pre></div>
 </div>
 <dl class="attribute">
@@ -634,7 +634,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dd><p>A generic printer knows where to redirect text for print.
 Use Printer.prints(output) to print the output instead of
 using the standard keyword</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="n">output</span><span class="p">)</span>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span> <span class="p">(</span><span class="n">output</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>in order to gain flexibility in redirecting output centrally.
@@ -872,7 +872,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2019, Author.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
     </div>
   </body>
 </html>

docs/PyHEADTAIL.gpu.html

@@ -370,7 +370,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2019, Author.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
     </div>
   </body>
 </html>

docs/PyHEADTAIL.html

@@ -71,7 +71,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
 </li>
 <li class="toctree-l1"><a class="reference internal" href="PyHEADTAIL.field_maps.html">PyHEADTAIL.field_maps package</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="PyHEADTAIL.field_maps.html#submodules">Submodules</a></li>
-<li class="toctree-l2"><a class="reference internal" href="PyHEADTAIL.field_maps.html#module-PyHEADTAIL.field_maps.Transverse_Efield_map">PyHEADTAIL.field_maps.Transverse_Efield_map module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="PyHEADTAIL.field_maps.html#pyheadtail-field-maps-transverse-efield-map-module">PyHEADTAIL.field_maps.Transverse_Efield_map module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="PyHEADTAIL.field_maps.html#pyheadtail-field-maps-field-map-module">PyHEADTAIL.field_maps.field_map module</a></li>
 </ul>
 </li>
@@ -222,7 +222,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2019, Author.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
     </div>
   </body>
 </html>

docs/PyHEADTAIL.impedances.html

@@ -1058,7 +1058,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2019, Author.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.3.1.
     </div>
   </body>
 </html>