update docs

jswhit · Dec 28, 2020 · 8b236c9 · 8b236c9
1 parent 76c944d
commit 8b236c9
Show file tree

Hide file tree

Showing 12 changed files with 25 additions and 22 deletions.
diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/installing.doctree b/docs/_build/doctrees/installing.doctree
diff --git a/docs/_build/html/_sources/installing.rst.txt b/docs/_build/html/_sources/installing.rst.txt
@@ -13,16 +13,20 @@ Dependencies
 Instructions
 ------------
 
-The easiest way to get everything installed is to use pip_:
+The easiest way to get everything installed (on macosx and linux) is to use pip_:
 
     >>> pip install pygrib
 
 This will install all the dependencies for you (including the ECCODES_ C lib).
 
-If you're using Anaconda python, use conda_:
+If you're using Anaconda python (recommended for Windows), use conda_:
 
     >>> conda install -c conda-forge pygrib
 
+If using conda on windows, you may also need to set the ``ECCODES_DEFINITION_PATH`` 
+environment variable to ``$CONDA_PREFIX/Library/share/eccodes/definitions`` if you see
+an error saying ``boot.def`` cannot be found.
+
 .. _pip: http://pip.pypa.io/
 .. _conda: http://conda.io/
 .. _ECCODES: https://confluence.ecmwf.int/display/ECC/

diff --git a/docs/_build/html/_static/pygments.css b/docs/_build/html/_static/pygments.css
@@ -1,8 +1,8 @@
 pre { line-height: 125%; margin: 0; }
-td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
-span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
-td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
-span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+td.linenos pre { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
+span.linenos { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
+td.linenos pre.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
 .highlight .hll { background-color: #ffffcc }
 .highlight { background: #eeffcc; }
 .highlight .c { color: #408090; font-style: italic } /* Comment */

diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html
@@ -144,13 +144,6 @@ <h2>Example usage<a class="headerlink" href="#example-usage" title="Permalink to
 north to south.  nlats must be even.</p>
 </dd></dl>
 
-<dl class="py function">
-<dt id="pygrib.get_definitions_path">
-<code class="sig-prename descclassname">pygrib.</code><code class="sig-name descname">get_definitions_path</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pygrib.get_definitions_path" title="Permalink to this definition">¶</a></dt>
-<dd><p>return eccodes_definitions_path currently in use.</p>
-<p>If None, then definitions installed with linked eccodes lib are begin used.</p>
-</dd></dl>
-
 <dl class="py class">
 <dt id="pygrib.gribmessage">
 <em class="property">class </em><code class="sig-prename descclassname">pygrib.</code><code class="sig-name descname">gribmessage</code><a class="headerlink" href="#pygrib.gribmessage" title="Permalink to this definition">¶</a></dt>
@@ -493,8 +486,9 @@ <h2>Example usage<a class="headerlink" href="#example-usage" title="Permalink to
 
 <dl class="py function">
 <dt id="pygrib.set_definitions_path">
-<code class="sig-prename descclassname">pygrib.</code><code class="sig-name descname">set_definitions_path</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">eccodes_definition_path</span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygrib.set_definitions_path" title="Permalink to this definition">¶</a></dt>
-<dd><p>set path to eccodes definition files (grib tables).</p>
+<code class="sig-prename descclassname">pygrib.</code><code class="sig-name descname">set_definitions_path</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pygrib.set_definitions_path" title="Permalink to this definition">¶</a></dt>
+<dd><p>set_definition_path(ECCODES_DEFINITION_PATH)</p>
+<p>set path to eccodes definition files (grib tables).</p>
 </dd></dl>
 
 <dl class="py function">

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -103,8 +103,6 @@ <h2 id="G">G</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#pygrib.get_definitions_path">get_definitions_path() (in module pygrib)</a>
-</li>
       <li><a href="api.html#pygrib.gribmessage">gribmessage (class in pygrib)</a>
 </li>
   </ul></td>

diff --git a/docs/_build/html/installing.html b/docs/_build/html/installing.html
@@ -57,15 +57,18 @@ <h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to t
 </div>
 <div class="section" id="instructions">
 <h2>Instructions<a class="headerlink" href="#instructions" title="Permalink to this headline">¶</a></h2>
-<p>The easiest way to get everything installed is to use <a class="reference external" href="http://pip.pypa.io/">pip</a>:</p>
+<p>The easiest way to get everything installed (on macosx and linux) is to use <a class="reference external" href="http://pip.pypa.io/">pip</a>:</p>
 <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pip</span> <span class="n">install</span> <span class="n">pygrib</span>
 </pre></div>
 </div>
 <p>This will install all the dependencies for you (including the <a class="reference external" href="https://confluence.ecmwf.int/display/ECC/">ECCODES</a> C lib).</p>
-<p>If you’re using Anaconda python, use <a class="reference external" href="http://conda.io/">conda</a>:</p>
+<p>If you’re using Anaconda python (recommended for Windows), use <a class="reference external" href="http://conda.io/">conda</a>:</p>
 <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">pygrib</span>
 </pre></div>
 </div>
+<p>If using conda on windows, you may also need to set the <code class="docutils literal notranslate"><span class="pre">ECCODES_DEFINITION_PATH</span></code>
+environment variable to <code class="docutils literal notranslate"><span class="pre">$CONDA_PREFIX/Library/share/eccodes/definitions</span></code> if you see
+an error saying <code class="docutils literal notranslate"><span class="pre">boot.def</span></code> cannot be found.</p>
 </div>
 <div class="section" id="developing">
 <h2>Developing<a class="headerlink" href="#developing" title="Permalink to this headline">¶</a></h2>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/installing.rst b/docs/installing.rst
@@ -13,16 +13,20 @@ Dependencies
 Instructions
 ------------
 
-The easiest way to get everything installed is to use pip_:
+The easiest way to get everything installed (on macosx and linux) is to use pip_:
 
     >>> pip install pygrib
 
 This will install all the dependencies for you (including the ECCODES_ C lib).
 
-If you're using Anaconda python, use conda_:
+If you're using Anaconda python (recommended for Windows), use conda_:
 
     >>> conda install -c conda-forge pygrib
 
+If using conda on windows, you may also need to set the ``ECCODES_DEFINITION_PATH`` 
+environment variable to ``$CONDA_PREFIX/Library/share/eccodes/definitions`` if you see
+an error saying ``boot.def`` cannot be found.
+
 .. _pip: http://pip.pypa.io/
 .. _conda: http://conda.io/
 .. _ECCODES: https://confluence.ecmwf.int/display/ECC/