docs updates & rebuild for 0.0.3 release

corteva · Apr 16, 2019 · 4e7567b · 4e7567b
1 parent b34dfc6
commit 4e7567b
Show file tree

Hide file tree

Showing 40 changed files with 111 additions and 1,897 deletions.
diff --git a/Makefile b/Makefile
@@ -70,9 +70,9 @@ test: ## run tests quickly with the default Python
 	py.test
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	$(MAKE) -C docs clean
-	$(MAKE) -C docs html
-	$(BROWSER) docs/_build/html/index.html
+	$(MAKE) -C sphinx clean
+	$(MAKE) -C sphinx html
+	$(BROWSER) docs/html/index.html
 
 release: dist ## package and upload a release
 	twine upload dist/*

diff --git a/README.rst b/README.rst
@@ -4,21 +4,23 @@ geocube README
 
 Tool to convert geopandas vector data into rasterized xarray data.
 
+Documentation: https://corteva.github.io/geocube
+
+.. image:: https://img.shields.io/badge/license-BSD%203--Clause-yellow.svg
+    :target: https://github.com/corteva/geocube/blob/master/LICENSE
 
 .. image:: https://img.shields.io/pypi/v/geocube.svg
     :target: https://pypi.python.org/pypi/geocube
 
 .. image:: https://travis-ci.com/corteva/geocube.svg?branch=master
     :target: https://travis-ci.com/corteva/geocube
 
-.. image:: https://ci.appveyor.com/api/projects/status/bjxhlbt5tjsonwo8?svg=true
+.. image:: https://ci.appveyor.com/api/projects/status/bjxhlbt5tjsonwo8/branch/master?svg=true
     :target: https://ci.appveyor.com/project/snowman2/geocube
 
 .. image:: https://coveralls.io/repos/github/corteva/geocube/badge.svg?branch=master
     :target: https://coveralls.io/github/corteva/geocube?branch=master
 
-* Free software: BSD-3 Clause license
-* Documentation: https://corteva.github.io/geocube.
 
 Credits
 -------

diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 2b1479816aaf3e0a31cd832ce94f91e2
+config: 6963748d41c33193ea3788e385b215af
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/_modules/geocube/api/core.html b/docs/html/_modules/geocube/api/core.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>geocube.api.core &#8212; geocube 0.0.2 documentation</title>
+    <title>geocube.api.core &#8212; geocube 0.0.3 documentation</title>
     <link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -159,7 +159,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>

diff --git a/docs/html/_modules/geocube/exceptions.html b/docs/html/_modules/geocube/exceptions.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>geocube.exceptions &#8212; geocube 0.0.2 documentation</title>
+    <title>geocube.exceptions &#8212; geocube 0.0.3 documentation</title>
     <link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -49,22 +49,6 @@ <h1>Source code for geocube.exceptions</h1><div class="highlight"><pre>
 
 <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>
     <span class="sd">&quot;&quot;&quot;This is for errors in the vector data passed into GeoCube.&quot;&quot;&quot;</span></div>
-
-
-<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>
-    <span class="sd">&quot;&quot;&quot;This is the base exception for errors in the rioxarray extension.&quot;&quot;&quot;</span></div>
-
-
-<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>
-    <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>
-
-
-<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>
-    <span class="sd">&quot;&quot;&quot;This is an error when you have a 1 dimensional raster.&quot;&quot;&quot;</span></div>
-
-
-<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>
-    <span class="sd">&quot;&quot;&quot;This is for when you have a dataset with a single variable.&quot;&quot;&quot;</span></div>
 </pre></div>
 
           </div>
@@ -97,7 +81,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>

diff --git a/docs/html/_modules/geocube/geo_utils/crs.html b/docs/html/_modules/geocube/geo_utils/crs.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>geocube.geo_utils.crs &#8212; geocube 0.0.2 documentation</title>
+    <title>geocube.geo_utils.crs &#8212; geocube 0.0.3 documentation</title>
     <link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -94,7 +94,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>

diff --git a/docs/html/_modules/geocube/geo_utils/geobox.html b/docs/html/_modules/geocube/geo_utils/geobox.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>geocube.geo_utils.geobox &#8212; geocube 0.0.2 documentation</title>
+    <title>geocube.geo_utils.geobox &#8212; geocube 0.0.3 documentation</title>
     <link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -45,11 +45,11 @@ <h1>Source code for geocube.geo_utils.geobox</h1><div class="highlight"><pre>
 
 <span class="kn">import</span> <span class="nn">geopandas</span> <span class="k">as</span> <span class="nn">gpd</span>
 <span class="kn">import</span> <span class="nn">numpy</span>
+<span class="kn">import</span> <span class="nn">rioxarray</span>  <span class="c1"># noqa</span>
 <span class="kn">from</span> <span class="nn">datacube.utils</span> <span class="k">import</span> <span class="n">geometry</span>
 <span class="kn">from</span> <span class="nn">rasterio.crs</span> <span class="k">import</span> <span class="n">CRS</span>
 <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>
 
-<span class="kn">import</span> <span class="nn">geocube.xarray_extensions</span>  <span class="c1"># noqa</span>
 <span class="kn">from</span> <span class="nn">geocube.exceptions</span> <span class="k">import</span> <span class="n">VectorDataError</span>
 <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>
 <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>
         <li class="right" >
           <a href="../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>

diff --git a/docs/html/_modules/geocube/logger.html b/docs/html/_modules/geocube/logger.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>geocube.logger &#8212; geocube 0.0.2 documentation</title>
+    <title>geocube.logger &#8212; geocube 0.0.3 documentation</title>
     <link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -172,7 +172,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>

diff --git a/docs/html/_modules/geocube/rasterize.html b/docs/html/_modules/geocube/rasterize.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>geocube.rasterize &#8212; geocube 0.0.2 documentation</title>
+    <title>geocube.rasterize &#8212; geocube 0.0.3 documentation</title>
     <link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -118,7 +118,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>

diff --git a/docs/html/_modules/geocube/vector_to_cube.html b/docs/html/_modules/geocube/vector_to_cube.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>geocube.vector_to_cube &#8212; geocube 0.0.2 documentation</title>
+    <title>geocube.vector_to_cube &#8212; geocube 0.0.3 documentation</title>
     <link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
@@ -26,7 +26,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -49,7 +49,7 @@ <h1>Source code for geocube.vector_to_cube</h1><div class="highlight"><pre>
 <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>
 <span class="kn">from</span> <span class="nn">geocube.logger</span> <span class="k">import</span> <span class="n">get_logger</span>
 <span class="kn">from</span> <span class="nn">geocube.rasterize</span> <span class="k">import</span> <span class="n">rasterize_image</span>
-<span class="kn">from</span> <span class="nn">geocube.xarray_extensions.rioxarray</span> <span class="k">import</span> <span class="p">(</span>
+<span class="kn">from</span> <span class="nn">rioxarray.rioxarray</span> <span class="k">import</span> <span class="p">(</span>
     <span class="n">DEFAULT_GRID_MAP</span><span class="p">,</span>
     <span class="n">add_spatial_ref</span><span class="p">,</span>
     <span class="n">add_xy_grid_meta</span><span class="p">,</span>
@@ -423,7 +423,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">geocube 0.0.3 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>