Skip to content

Commit

Permalink
docs: update docs sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
ACornuIGN committed Oct 7, 2024
1 parent f5c15a3 commit 4536add
Show file tree
Hide file tree
Showing 77 changed files with 498 additions and 30 deletions.
Binary file modified docs/sphinx/_build/doctrees/borea.utils.check.doctree
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/borea.utils.solver.doctree
Binary file not shown.
Binary file modified docs/sphinx/_build/doctrees/environment.pickle
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
5 changes: 3 additions & 2 deletions docs/sphinx/_build/html/_modules/borea/datastruct/dtm.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down Expand Up @@ -275,11 +276,11 @@ <h1>Source code for borea.datastruct.dtm</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">A module for manipulating a digital elevation model.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span><span class="p">,</span> <span class="n">PureWindowsPath</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">osgeo</span> <span class="kn">import</span> <span class="n">gdal</span>
<span class="kn">from</span> <span class="nn">scipy</span> <span class="kn">import</span> <span class="n">ndimage</span>
<span class="kn">from</span> <span class="nn">borea.transform_world_image.transform_dtm.world_image_dtm</span> <span class="kn">import</span> <span class="n">WorldImageDtm</span>
<span class="kn">from</span> <span class="nn">borea.utils.check.check_path</span> <span class="kn">import</span> <span class="n">check_path</span>
<span class="kn">from</span> <span class="nn">borea.utils.singleton.singleton</span> <span class="kn">import</span> <span class="n">Singleton</span>
<span class="n">gdal</span><span class="o">.</span><span class="n">UseExceptions</span><span class="p">()</span>

Expand Down Expand Up @@ -327,7 +328,7 @@ <h1>Source code for borea.datastruct.dtm</h1><div class="highlight"><pre>
<span class="k">if</span> <span class="n">path_dtm</span><span class="p">:</span>
<span class="n">gdal</span><span class="o">.</span><span class="n">AllRegister</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">type_dtm</span> <span class="o">=</span> <span class="n">type_dtm</span>
<span class="bp">self</span><span class="o">.</span><span class="n">path_dtm</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">PureWindowsPath</span><span class="p">(</span><span class="n">path_dtm</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">path_dtm</span> <span class="o">=</span> <span class="n">check_path</span><span class="p">(</span><span class="n">path_dtm</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">img</span> <span class="o">=</span> <span class="n">gdal</span><span class="o">.</span><span class="n">Open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path_dtm</span><span class="o">.</span><span class="n">as_posix</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rb</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">img</span><span class="o">.</span><span class="n">GetRasterBand</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nodata</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">rb</span><span class="o">.</span><span class="n">GetNoDataValue</span><span class="p">()</span>
Expand Down
1 change: 1 addition & 0 deletions docs/sphinx/_build/html/_modules/borea/datastruct/gcp.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/sphinx/_build/html/_modules/borea/format/conl.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
1 change: 1 addition & 0 deletions docs/sphinx/_build/html/_modules/borea/format/rpc.html
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.check.html">borea.utils.check package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.miscellaneous.html">borea.utils.miscellaneous package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.singleton.html">borea.utils.singleton package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.solver.html">borea.utils.solver package</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../../borea.utils.xml.html">borea.utils.xml package</a></li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 4536add

Please sign in to comment.