Publish ESMPy Docs

esmf-org · Sep 8, 2023 · 7c1968a · 7c1968a
1 parent 86f689b
commit 7c1968a
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/docs/nightly/develop/ESMPy.pdf b/docs/nightly/develop/ESMPy.pdf
diff --git a/docs/nightly/develop/html/_sources/install.rst.txt b/docs/nightly/develop/html/_sources/install.rst.txt
@@ -127,6 +127,14 @@ greater test coverage is desired:
     (allowing the stress on the machine to be applied to bandwidth first, and 
     then memory).
 
+.. Note::
+
+   By default, test data will be downloaded to a ``data`` subdirectory of the ESMPy installation directory. This location can be changed by setting one of the following environment variables:
+
+   - If ``ESMPY_DATA_DIR`` is set, this should point to a directory that has already been populated with the necessary data; the pre-existing data will be read from this directory and no automatic downloads will be attempted.
+
+   - Otherwise, if ``ESMPY_DATA_NEW_DIR`` is set, data will be downloaded to the path set by this variable instead of using the ``data`` subdirectory of the ESMPy installation directory.
+
 -----------
 Limitations
 -----------

diff --git a/docs/nightly/develop/html/install.html b/docs/nightly/develop/html/install.html
@@ -154,6 +154,14 @@ <h2>Validation<a class="headerlink" href="#validation" title="Permalink to this
 (allowing the stress on the machine to be applied to bandwidth first, and
 then memory).</p>
 </div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>By default, test data will be downloaded to a <code class="docutils literal notranslate"><span class="pre">data</span></code> subdirectory of the ESMPy installation directory. This location can be changed by setting one of the following environment variables:</p>
+<ul class="simple">
+<li><p>If <code class="docutils literal notranslate"><span class="pre">ESMPY_DATA_DIR</span></code> is set, this should point to a directory that has already been populated with the necessary data; the pre-existing data will be read from this directory and no automatic downloads will be attempted.</p></li>
+<li><p>Otherwise, if <code class="docutils literal notranslate"><span class="pre">ESMPY_DATA_NEW_DIR</span></code> is set, data will be downloaded to the path set by this variable instead of using the <code class="docutils literal notranslate"><span class="pre">data</span></code> subdirectory of the ESMPy installation directory.</p></li>
+</ul>
+</div>
 </section>
 <section id="limitations">
 <h2>Limitations<a class="headerlink" href="#limitations" title="Permalink to this heading">¶</a></h2>

diff --git a/docs/nightly/develop/html/searchindex.js b/docs/nightly/develop/html/searchindex.js