Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 22, 2024
1 parent 66307a6 commit 3e5348a
Show file tree
Hide file tree
Showing 122 changed files with 281 additions and 1 deletion.
2 changes: 1 addition & 1 deletion main/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9aaa2d8e9d86e6439427e585b04b3c1d
config: 518676fa7dfb941c6e17a1b7f416f8f7
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified main/.doctrees/adding_features.doctree
Binary file not shown.
Binary file modified main/.doctrees/aggregation.doctree
Binary file not shown.
Binary file modified main/.doctrees/api.doctree
Binary file not shown.
Binary file modified main/.doctrees/build_docs.doctree
Binary file not shown.
Binary file modified main/.doctrees/environment.pickle
Binary file not shown.
Binary file modified main/.doctrees/feature_collection.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified main/.doctrees/generated/geometric_features.aggregation.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified main/.doctrees/generated/geometric_features.tag_features.doctree
Binary file not shown.
Binary file not shown.
Binary file modified main/.doctrees/geometric_data.doctree
Binary file not shown.
Binary file modified main/.doctrees/geometric_features.doctree
Binary file not shown.
Binary file modified main/.doctrees/index.doctree
Binary file not shown.
Binary file modified main/.doctrees/quick_start.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions main/_modules/geometric_features/__main__.html
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,10 @@ <h1>Source code for geometric_features.__main__</h1><div class="highlight"><pre>
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="__main__.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/_modules/geometric_features/aggregation.html
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,10 @@ <h1>Source code for geometric_features.aggregation</h1><div class="highlight"><p
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="aggregation.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@ <h1>Source code for geometric_features.aggregation.landice.nasa_greenland_extend
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="nasa_greenland_extended.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,10 @@ <h1>Source code for geometric_features.aggregation.ocean.antarctic_regions</h1><
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="antarctic_regions.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@ <h1>Source code for geometric_features.aggregation.ocean.arctic_regions</h1><div
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="arctic_regions.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,10 @@ <h1>Source code for geometric_features.aggregation.ocean.ice_shelf_regions</h1><
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="ice_shelf_regions.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,10 @@ <h1>Source code for geometric_features.aggregation.ocean.ismip6_greenland_region
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="ismip6_greenland_regions.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,10 @@ <h1>Source code for geometric_features.aggregation.ocean.moc_basins</h1><div cla
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="moc_basins.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ <h1>Source code for geometric_features.aggregation.ocean.ocean_basins</h1><div c
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="ocean_basins.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,10 @@ <h1>Source code for geometric_features.aggregation.ocean.subbasin_regions</h1><d
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="subbasin_regions.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ <h1>Source code for geometric_features.aggregation.ocean.transport_transects</h1
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="transport_transects.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ <h1>Source code for geometric_features.aggregation.seaice.arctic_regions</h1><di
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="arctic_regions.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,10 @@ <h1>Source code for geometric_features.aggregation.seaice.historical_sea_ice</h1
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="historical_sea_ice.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/_modules/geometric_features/feature_collection.html
Original file line number Diff line number Diff line change
Expand Up @@ -901,6 +901,10 @@ <h1>Source code for geometric_features.feature_collection</h1><div class="highli
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="feature_collection.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/_modules/geometric_features/geometric_features.html
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,10 @@ <h1>Source code for geometric_features.geometric_features</h1><div class="highli
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/_modules/geometric_features/utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,10 @@ <h1>Source code for geometric_features.utils</h1><div class="highlight"><pre>
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="utils.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ <h1>All modules for which code is available</h1>
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="index.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/adding_features.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,10 @@
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../1.6.1/adding_features.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="adding_features.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/aggregation.html
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,10 @@ <h3>Arctic Regions<a class="headerlink" href="#id1" title="Link to this heading"
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../1.6.1/aggregation.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="aggregation.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,10 @@ <h3>Aggregation<a class="headerlink" href="#aggregation" title="Link to this hea
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../1.6.1/api.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="api.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/build_docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../1.6.1/build_docs.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="build_docs.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/feature_collection.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,10 @@ <h2>Fix Features at +/- 180<a class="headerlink" href="#fix-features-at-180" tit
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../1.6.1/feature_collection.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="feature_collection.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ <h1>geometric_features.FeatureCollection.add_feature<a class="headerlink" href="
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.add_feature.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,10 @@ <h1>geometric_features.FeatureCollection.combine<a class="headerlink" href="#geo
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.combine.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,10 @@ <h1>geometric_features.FeatureCollection.difference<a class="headerlink" href="#
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.difference.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ <h1>geometric_features.FeatureCollection.feature_in_collection<a class="headerli
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.feature_in_collection.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@ <h1>geometric_features.FeatureCollection.fix_antimeridian<a class="headerlink" h
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.fix_antimeridian.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/generated/geometric_features.FeatureCollection.html
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,10 @@ <h1>geometric_features.FeatureCollection<a class="headerlink" href="#geometric-f
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ <h1>geometric_features.FeatureCollection.merge<a class="headerlink" href="#geome
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.merge.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/generated/geometric_features.FeatureCollection.plot.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,10 @@ <h1>geometric_features.FeatureCollection.plot<a class="headerlink" href="#geomet
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.plot.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ <h1>geometric_features.FeatureCollection.set_group_name<a class="headerlink" hre
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.set_group_name.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ <h1>geometric_features.FeatureCollection.simplify<a class="headerlink" href="#ge
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.simplify.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/generated/geometric_features.FeatureCollection.tag.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ <h1>geometric_features.FeatureCollection.tag<a class="headerlink" href="#geometr
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.tag.html">main</a></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,10 @@ <h1>geometric_features.FeatureCollection.to_geojson<a class="headerlink" href="#
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.FeatureCollection.to_geojson.html">main</a></dd>
Expand Down
4 changes: 4 additions & 0 deletions main/generated/geometric_features.GeometricFeatures.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,10 @@ <h1>geometric_features.GeometricFeatures<a class="headerlink" href="#geometric-f
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Tags</dt>
<dd><a href="../../1.6.1/index.html">1.6.1</a></dd>
</dl>
<dl>
<dt>Branches</dt>
<dd><a href="geometric_features.GeometricFeatures.html">main</a></dd>
Expand Down
Loading

0 comments on commit 3e5348a

Please sign in to comment.