Skip to content

Commit

Permalink
Autobuild documentation [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
CircleCI committed Jul 11, 2024
1 parent c7afc07 commit e8dc214
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
26 changes: 13 additions & 13 deletions python/vsi.tools.html
Original file line number Diff line number Diff line change
Expand Up @@ -676,12 +676,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>axes</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The first Axes</p></li>
<li><p><strong>axes</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The first Axes</p></li>
<li><p><strong>img</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a>) – Image array</p></li>
<li><p><strong>origin</strong> (<a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#tuple" title="(in Python v3.7)"><em>tuple</em></a>) – The origin of the chip to load, in y, x, order</p></li>
<li><p><strong>size</strong> – The size of the chip to load, in y, x, order</p></li>
<li><p><strong>*args</strong> – Additional parameters passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html#matplotlib.pyplot.imshow" title="(in Matplotlib v3.9.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.imshow()</span></code></a></p></li>
<li><p><strong>**kwargs</strong> – Additional keyword arguments passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html#matplotlib.pyplot.imshow" title="(in Matplotlib v3.9.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.imshow()</span></code></a></p></li>
<li><p><strong>*args</strong> – Additional parameters passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html#matplotlib.pyplot.imshow" title="(in Matplotlib v3.9.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.imshow()</span></code></a></p></li>
<li><p><strong>**kwargs</strong> – Additional keyword arguments passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html#matplotlib.pyplot.imshow" title="(in Matplotlib v3.9.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.imshow()</span></code></a></p></li>
</ul>
</dd>
</dl>
Expand All @@ -696,12 +696,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>axes</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The first Axes</p></li>
<li><p><strong>axes</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The first Axes</p></li>
<li><p><strong>raster</strong> (<a class="reference external" href="https://rasterio.readthedocs.io/en/stable/api/rasterio.io.html#rasterio.io.DatasetReader" title="(in rasterio v1.3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">rasterio.io.DatasetReader</span></code></a>) – rasterio dataset object</p></li>
<li><p><strong>origin</strong> – The origin of the chip to load, in y, x, order</p></li>
<li><p><strong>size</strong> – The size of the chip to load, in y, x, order</p></li>
<li><p><strong>*args</strong> – Additional parameters passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html#matplotlib.pyplot.imshow" title="(in Matplotlib v3.9.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.imshow()</span></code></a></p></li>
<li><p><strong>**kwargs</strong> – Additional keyword arguments passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html#matplotlib.pyplot.imshow" title="(in Matplotlib v3.9.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.imshow()</span></code></a></p></li>
<li><p><strong>*args</strong> – Additional parameters passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html#matplotlib.pyplot.imshow" title="(in Matplotlib v3.9.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.imshow()</span></code></a></p></li>
<li><p><strong>**kwargs</strong> – Additional keyword arguments passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.imshow.html#matplotlib.pyplot.imshow" title="(in Matplotlib v3.9.1)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.imshow()</span></code></a></p></li>
</ul>
</dd>
</dl>
Expand All @@ -715,8 +715,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ax1</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The first Axes</p></li>
<li><p><strong>ax2</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The second Axes</p></li>
<li><p><strong>ax1</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The first Axes</p></li>
<li><p><strong>ax2</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The second Axes</p></li>
<li><p><strong>forward</strong> (<em>Callable</em>) – A function that takes the arguments <code class="docutils literal notranslate"><span class="pre">x0</span></code>, <code class="docutils literal notranslate"><span class="pre">x1</span></code>, <code class="docutils literal notranslate"><span class="pre">y0</span></code>, <code class="docutils literal notranslate"><span class="pre">y1</span></code> for
<code class="docutils literal notranslate"><span class="pre">ax1</span></code> and returns <code class="docutils literal notranslate"><span class="pre">(x0,</span> <span class="pre">x1,</span> <span class="pre">y0,</span> <span class="pre">y1)</span></code> for <code class="docutils literal notranslate"><span class="pre">ax2</span></code>. Return <code class="docutils literal notranslate"><span class="pre">None</span></code> to
indicate that no update to <code class="docutils literal notranslate"><span class="pre">ax2</span></code> should be performed.</p></li>
Expand All @@ -738,16 +738,16 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd class="field-odd"><ul class="simple">
<li><p><strong>z</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a>) – The z data</p></li>
<li><p><strong>cmap</strong> – The colormap used to color based on z height. Default: jet</p></li>
<li><p><strong>ax</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The axes to draw on. Default: gca()</p></li>
<li><p><strong>ax</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="(in Matplotlib v3.9.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.axes.Axes</span></code></a>) – The axes to draw on. Default: gca()</p></li>
<li><p><strong>x</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a>, optional) – The x coordinate used to draw. Default uses <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.meshgrid.html#numpy.meshgrid" title="(in NumPy v2.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.meshgrid()</span></code></a></p></li>
<li><p><strong>y</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a>, optional) – The y coordinate used to draw. Default uses <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.meshgrid.html#numpy.meshgrid" title="(in NumPy v2.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">numpy.meshgrid()</span></code></a></p></li>
<li><p><strong>c</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a>, optional) – A custom array that is fed into the colormap for coloring. Default uses
<code class="docutils literal notranslate"><span class="pre">z</span></code></p></li>
<li><p><strong>**kwargs</strong> (<a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – Additional keyword arguments passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface.html#mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface" title="(in Matplotlib v3.9.0)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface()</span></code></a></p></li>
<li><p><strong>**kwargs</strong> (<a class="reference external" href="https://docs.python.org/3.7/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – Additional keyword arguments passed to <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface.html#mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface" title="(in Matplotlib v3.9.1)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface()</span></code></a></p></li>
</ul>
</dd>
</dl>
<p>By default, <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface.html#mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface" title="(in Matplotlib v3.9.0)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface()</span></code></a> does not
<p>By default, <a class="reference external" href="https://matplotlib.org/stable/api/_as_gen/mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface.html#mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface" title="(in Matplotlib v3.9.1)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mpl_toolkits.mplot3d.axes3d.Axes3D.plot_surface()</span></code></a> does not
draw the entire mesh, it downsamples it to 50 points instead (for
efficiency). To disable downsampling, consider setting <code class="docutils literal notranslate"><span class="pre">rstride</span></code> and
<code class="docutils literal notranslate"><span class="pre">cstride</span></code> to <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>
Expand All @@ -771,7 +771,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd class="field-even"><p>The Zoomed Figure</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://matplotlib.org/stable/api/figure_api.html#module-matplotlib.figure" title="(in Matplotlib v3.9.0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.figure</span></code></a></p>
<dd class="field-odd"><p><a class="reference external" href="https://matplotlib.org/stable/api/figure_api.html#module-matplotlib.figure" title="(in Matplotlib v3.9.1)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.figure</span></code></a></p>
</dd>
</dl>
</dd></dl>
Expand All @@ -782,7 +782,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ax</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/axes_api.html#module-matplotlib.axes" title="(in Matplotlib v3.9.0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.axes</span></code></a>) – The Axes</p></li>
<li><p><strong>ax</strong> (<a class="reference external" href="https://matplotlib.org/stable/api/axes_api.html#module-matplotlib.axes" title="(in Matplotlib v3.9.1)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.axes</span></code></a>) – The Axes</p></li>
<li><p><strong>base_scale</strong> (<a class="reference external" href="https://docs.python.org/3.7/library/functions.html#float" title="(in Python v3.7)"><em>float</em></a>) – The Base Scale</p></li>
</ul>
</dd>
Expand Down
4 changes: 2 additions & 2 deletions python/vsi.tools.network.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,12 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3.7/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="vsi.tools.network.localdatatest.Average.add_full">
<span class="sig-name descname"><span class="pre">add_full</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1719938179.1880496</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/vsi/tools/network/localdatatest.html#Average.add_full"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#vsi.tools.network.localdatatest.Average.add_full" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">add_full</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1720727699.388264</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/vsi/tools/network/localdatatest.html#Average.add_full"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#vsi.tools.network.localdatatest.Average.add_full" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="vsi.tools.network.localdatatest.Average.add_partial">
<span class="sig-name descname"><span class="pre">add_partial</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1719938179.188049</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/vsi/tools/network/localdatatest.html#Average.add_partial"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#vsi.tools.network.localdatatest.Average.add_partial" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">add_partial</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1720727699.3882635</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/vsi/tools/network/localdatatest.html#Average.add_partial"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#vsi.tools.network.localdatatest.Average.add_partial" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit e8dc214

Please sign in to comment.