Skip to content

Commit 4e7567b

Browse files
snowman2snowman2
committed
docs updates & rebuild for 0.0.3 release
1 parent b34dfc6 commit 4e7567b

40 files changed

+111
-1897
lines changed

‎Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ test: ## run tests quickly with the default Python
7070
py.test
7171

7272
docs: ## generate Sphinx HTML documentation, including API docs
73-
$(MAKE) -C docs clean
74-
$(MAKE) -C docs html
75-
$(BROWSER) docs/_build/html/index.html
73+
$(MAKE) -C sphinx clean
74+
$(MAKE) -C sphinx html
75+
$(BROWSER) docs/html/index.html
7676

7777
release: dist ## package and upload a release
7878
twine upload dist/*

‎README.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@ geocube README
44

55
Tool to convert geopandas vector data into rasterized xarray data.
66

7+
Documentation: https://corteva.github.io/geocube
8+
9+
.. image:: https://img.shields.io/badge/license-BSD%203--Clause-yellow.svg
10+
:target: https://github.com/corteva/geocube/blob/master/LICENSE
711

812
.. image:: https://img.shields.io/pypi/v/geocube.svg
913
:target: https://pypi.python.org/pypi/geocube
1014

1115
.. image:: https://travis-ci.com/corteva/geocube.svg?branch=master
1216
:target: https://travis-ci.com/corteva/geocube
1317

14-
.. image:: https://ci.appveyor.com/api/projects/status/bjxhlbt5tjsonwo8?svg=true
18+
.. image:: https://ci.appveyor.com/api/projects/status/bjxhlbt5tjsonwo8/branch/master?svg=true
1519
:target: https://ci.appveyor.com/project/snowman2/geocube
1620

1721
.. image:: https://coveralls.io/repos/github/corteva/geocube/badge.svg?branch=master
1822
:target: https://coveralls.io/github/corteva/geocube?branch=master
1923

20-
* Free software: BSD-3 Clause license
21-
* Documentation: https://corteva.github.io/geocube.
2224

2325
Credits
2426
-------

‎docs/html/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 2b1479816aaf3e0a31cd832ce94f91e2
3+
config: 6963748d41c33193ea3788e385b215af
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/html/_modules/geocube/api/core.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>geocube.api.core &#8212; geocube 0.0.2 documentation</title>
9+
<title>geocube.api.core &#8212; geocube 0.0.3 documentation</title>
1010
<link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
3131
</ul>
3232
</div>
@@ -159,7 +159,7 @@ <h3>Navigation</h3>
159159
<li class="right" >
160160
<a href="../../../py-modindex.html" title="Python Module Index"
161161
>modules</a> |</li>
162-
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
162+
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
163163
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
164164
</ul>
165165
</div>

‎docs/html/_modules/geocube/exceptions.html

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>geocube.exceptions &#8212; geocube 0.0.2 documentation</title>
9+
<title>geocube.exceptions &#8212; geocube 0.0.3 documentation</title>
1010
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3131
</ul>
3232
</div>
@@ -49,22 +49,6 @@ <h1>Source code for geocube.exceptions</h1><div class="highlight"><pre>
4949

5050
<div class="viewcode-block" id="VectorDataError"><a class="viewcode-back" href="../../geocube.html#geocube.exceptions.VectorDataError">[docs]</a><span class="k">class</span> <span class="nc">VectorDataError</span><span class="p">(</span><span class="n">GeoCubeError</span><span class="p">):</span>
5151
<span class="sd">&quot;&quot;&quot;This is for errors in the vector data passed into GeoCube.&quot;&quot;&quot;</span></div>
52-
53-
54-
<div class="viewcode-block" id="RioXarrayError"><a class="viewcode-back" href="../../geocube.html#geocube.exceptions.RioXarrayError">[docs]</a><span class="k">class</span> <span class="nc">RioXarrayError</span><span class="p">(</span><span class="ne">RuntimeError</span><span class="p">):</span>
55-
<span class="sd">&quot;&quot;&quot;This is the base exception for errors in the rioxarray extension.&quot;&quot;&quot;</span></div>
56-
57-
58-
<div class="viewcode-block" id="NoDataInBounds"><a class="viewcode-back" href="../../geocube.html#geocube.exceptions.NoDataInBounds">[docs]</a><span class="k">class</span> <span class="nc">NoDataInBounds</span><span class="p">(</span><span class="n">RioXarrayError</span><span class="p">):</span>
59-
<span class="sd">&quot;&quot;&quot;This is for when there are no data in the bounds for clipping a raster.&quot;&quot;&quot;</span></div>
60-
61-
62-
<div class="viewcode-block" id="OneDimensionalRaster"><a class="viewcode-back" href="../../geocube.html#geocube.exceptions.OneDimensionalRaster">[docs]</a><span class="k">class</span> <span class="nc">OneDimensionalRaster</span><span class="p">(</span><span class="n">RioXarrayError</span><span class="p">):</span>
63-
<span class="sd">&quot;&quot;&quot;This is an error when you have a 1 dimensional raster.&quot;&quot;&quot;</span></div>
64-
65-
66-
<div class="viewcode-block" id="SingleVariableDataset"><a class="viewcode-back" href="../../geocube.html#geocube.exceptions.SingleVariableDataset">[docs]</a><span class="k">class</span> <span class="nc">SingleVariableDataset</span><span class="p">(</span><span class="n">RioXarrayError</span><span class="p">):</span>
67-
<span class="sd">&quot;&quot;&quot;This is for when you have a dataset with a single variable.&quot;&quot;&quot;</span></div>
6852
</pre></div>
6953

7054
</div>
@@ -97,7 +81,7 @@ <h3>Navigation</h3>
9781
<li class="right" >
9882
<a href="../../py-modindex.html" title="Python Module Index"
9983
>modules</a> |</li>
100-
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
84+
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
10185
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
10286
</ul>
10387
</div>

‎docs/html/_modules/geocube/geo_utils/crs.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>geocube.geo_utils.crs &#8212; geocube 0.0.2 documentation</title>
9+
<title>geocube.geo_utils.crs &#8212; geocube 0.0.3 documentation</title>
1010
<link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
3131
</ul>
3232
</div>
@@ -94,7 +94,7 @@ <h3>Navigation</h3>
9494
<li class="right" >
9595
<a href="../../../py-modindex.html" title="Python Module Index"
9696
>modules</a> |</li>
97-
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
97+
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
9898
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
9999
</ul>
100100
</div>

‎docs/html/_modules/geocube/geo_utils/geobox.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>geocube.geo_utils.geobox &#8212; geocube 0.0.2 documentation</title>
9+
<title>geocube.geo_utils.geobox &#8212; geocube 0.0.3 documentation</title>
1010
<link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
3131
</ul>
3232
</div>
@@ -45,11 +45,11 @@ <h1>Source code for geocube.geo_utils.geobox</h1><div class="highlight"><pre>
4545

4646
<span class="kn">import</span> <span class="nn">geopandas</span> <span class="k">as</span> <span class="nn">gpd</span>
4747
<span class="kn">import</span> <span class="nn">numpy</span>
48+
<span class="kn">import</span> <span class="nn">rioxarray</span> <span class="c1"># noqa</span>
4849
<span class="kn">from</span> <span class="nn">datacube.utils</span> <span class="k">import</span> <span class="n">geometry</span>
4950
<span class="kn">from</span> <span class="nn">rasterio.crs</span> <span class="k">import</span> <span class="n">CRS</span>
5051
<span class="kn">from</span> <span class="nn">shapely.geometry</span> <span class="k">import</span> <span class="n">box</span><span class="p">,</span> <span class="n">mapping</span>
5152

52-
<span class="kn">import</span> <span class="nn">geocube.xarray_extensions</span> <span class="c1"># noqa</span>
5353
<span class="kn">from</span> <span class="nn">geocube.exceptions</span> <span class="k">import</span> <span class="n">VectorDataError</span>
5454
<span class="kn">from</span> <span class="nn">geocube.geo_utils.crs</span> <span class="k">import</span> <span class="n">crs_to_wkt</span>
5555
<span class="kn">from</span> <span class="nn">geocube.logger</span> <span class="k">import</span> <span class="n">get_logger</span>
@@ -247,7 +247,7 @@ <h3>Navigation</h3>
247247
<li class="right" >
248248
<a href="../../../py-modindex.html" title="Python Module Index"
249249
>modules</a> |</li>
250-
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
250+
<li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
251251
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
252252
</ul>
253253
</div>

‎docs/html/_modules/geocube/logger.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>geocube.logger &#8212; geocube 0.0.2 documentation</title>
9+
<title>geocube.logger &#8212; geocube 0.0.3 documentation</title>
1010
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3131
</ul>
3232
</div>
@@ -172,7 +172,7 @@ <h3>Navigation</h3>
172172
<li class="right" >
173173
<a href="../../py-modindex.html" title="Python Module Index"
174174
>modules</a> |</li>
175-
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
175+
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
176176
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
177177
</ul>
178178
</div>

‎docs/html/_modules/geocube/rasterize.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>geocube.rasterize &#8212; geocube 0.0.2 documentation</title>
9+
<title>geocube.rasterize &#8212; geocube 0.0.3 documentation</title>
1010
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3131
</ul>
3232
</div>
@@ -118,7 +118,7 @@ <h3>Navigation</h3>
118118
<li class="right" >
119119
<a href="../../py-modindex.html" title="Python Module Index"
120120
>modules</a> |</li>
121-
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
121+
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
122122
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
123123
</ul>
124124
</div>

‎docs/html/_modules/geocube/vector_to_cube.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>geocube.vector_to_cube &#8212; geocube 0.0.2 documentation</title>
9+
<title>geocube.vector_to_cube &#8212; geocube 0.0.3 documentation</title>
1010
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3131
</ul>
3232
</div>
@@ -49,7 +49,7 @@ <h1>Source code for geocube.vector_to_cube</h1><div class="highlight"><pre>
4949
<span class="kn">from</span> <span class="nn">geocube.geo_utils.geobox</span> <span class="k">import</span> <span class="n">load_vector_data</span>
5050
<span class="kn">from</span> <span class="nn">geocube.logger</span> <span class="k">import</span> <span class="n">get_logger</span>
5151
<span class="kn">from</span> <span class="nn">geocube.rasterize</span> <span class="k">import</span> <span class="n">rasterize_image</span>
52-
<span class="kn">from</span> <span class="nn">geocube.xarray_extensions.rioxarray</span> <span class="k">import</span> <span class="p">(</span>
52+
<span class="kn">from</span> <span class="nn">rioxarray.rioxarray</span> <span class="k">import</span> <span class="p">(</span>
5353
<span class="n">DEFAULT_GRID_MAP</span><span class="p">,</span>
5454
<span class="n">add_spatial_ref</span><span class="p">,</span>
5555
<span class="n">add_xy_grid_meta</span><span class="p">,</span>
@@ -423,7 +423,7 @@ <h3>Navigation</h3>
423423
<li class="right" >
424424
<a href="../../py-modindex.html" title="Python Module Index"
425425
>modules</a> |</li>
426-
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
426+
<li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
427427
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
428428
</ul>
429429
</div>

0 commit comments

Comments
 (0)