adding read the doc 128

imohamme · Feb 28, 2023 · 9301796 · 9301796
1 parent 9378a47
commit 9301796
Show file tree

Hide file tree

Showing 15 changed files with 17 additions and 17 deletions.
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/nasaaccess_R.doctree b/docs/_build/doctrees/nasaaccess_R.doctree
diff --git a/docs/_build/doctrees/nasaaccess_tethys.doctree b/docs/_build/doctrees/nasaaccess_tethys.doctree
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to NASAaccess's documentation!
+Welcome to NASAaccess's documentation
 ======================================
 
 .. |ORCID Substitution| image:: https://info.orcid.org/wp-content/uploads/2019/11/orcid_32x32.png

diff --git a/docs/_build/html/_sources/nasaaccess_R.rst.txt b/docs/_build/html/_sources/nasaaccess_R.rst.txt
@@ -34,7 +34,7 @@ On a local machine the user should have installed the following programs as well
 Manual creation of the *.netrc* file
 ====================================
 
-The *.netrc* file and the *_netrc* file (only for Windows OS machines) are generated automatically when installing the *NASAaccess* software package. However, if the user wants to create theses access files manually here are the steps needed.
+The *.netrc* file and the *_netrc* file (only for Windows OS machines) are generated automatically when installing the *NASAaccess* R software package. However, if the user wants to create theses access files manually here are the steps needed.
 
 
 #. Define `HOME` variable in your Environment Variables by picking any directory you want to be referenced as your `HOME` directory. For convenient installation, the user should go with the machine default `HOME` directory. In many Winodws OS machines `HOME` directory is the user personal `Documents` folder (i.e., C:\\Users\\yourname\\Documents).

diff --git a/docs/_build/html/_sources/nasaaccess_tethys.rst.txt b/docs/_build/html/_sources/nasaaccess_tethys.rst.txt
@@ -63,9 +63,9 @@ Installation/Setup
 - EarthData:
       **NASAaccess** needs a user registration access with `Earthdata <https://www.earthdata.nasa.gov/>`_. Users should set up a registration account(s) with Earthdata login as well as authorizing NASA GES DISC data access. Please refer to https://disc.gsfc.nasa.gov/data-access for further details.
 
-            -   After registration with `Earthdata <https://www.earthdata.nasa.gov/>`_ *NASAaccess* software package users should create a reference file (*netrc*) with `Earthdata <https://www.earthdata.nasa.gov/>`_ credentials stored in it to streamline the retrieval access to `NASA <https://www.nasa.gov/>`_ servers.
+            -   After registration with `Earthdata <https://www.earthdata.nasa.gov/>`_ *NASAaccess* software package users should create a reference file (*.netrc*) with `Earthdata <https://www.earthdata.nasa.gov/>`_ credentials stored in it to streamline the retrieval access from `NASA <https://www.nasa.gov/>`_ servers.
 
-            -   Creating the *.netrc* file at the user machine *Home* directory and storing the user `NASA <https://www.nasa.gov/>`_ `GES DISC <https://disc.gsfc.nasa.gov/>`_ logging information in it is needed to execute the *NASAaccess* package commands. Accessing data at NASA servers is further explained at https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget. The manual steps for creating *.netrc* file has been discussed in `NASAaccess R package installation  <nasaaccess_R.html>`_.
+            -   Creating the *.netrc* file at the user *Home* directory and storing the user `NASA <https://www.nasa.gov/>`_ `GES DISC <https://disc.gsfc.nasa.gov/>`_ logging information in it is needed to execute the *NASAaccess* package commands. Accessing data at NASA servers is further explained at https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget. The manual steps for creating *.netrc* file has been discussed in `NASAaccess R package installation  <nasaaccess_R.html>`_.
 
 - Tethys:
       The **NASAaccess** Tethys Application requires the Tethys Platform to be installed beforehand. The Tethys Platform Framework installation process can be installed in a development and production environment. There is a couple of differences between both installations:

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Welcome to NASAaccess’s documentation! &mdash; NASAaccess 3.3.1 documentation</title>
+  <title>Welcome to NASAaccess’s documentation &mdash; NASAaccess 3.3.1 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -61,7 +61,7 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
-      <li class="breadcrumb-item active">Welcome to NASAaccess’s documentation!</li>
+      <li class="breadcrumb-item active">Welcome to NASAaccess’s documentation</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
       </li>
@@ -72,7 +72,7 @@
            <div itemprop="articleBody">
 
   <div class="section" id="welcome-to-nasaaccess-s-documentation">
-<h1>Welcome to NASAaccess’s documentation!<a class="headerlink" href="#welcome-to-nasaaccess-s-documentation" title="Permalink to this heading"></a></h1>
+<h1>Welcome to NASAaccess’s documentation<a class="headerlink" href="#welcome-to-nasaaccess-s-documentation" title="Permalink to this heading"></a></h1>
 <table class="colwidths-auto docutils align-default">
 <tbody>
 <tr class="row-odd"><td><p><strong>Ibrahim N. Mohammed</strong></p></td>

diff --git a/docs/_build/html/nasaaccess_R.html b/docs/_build/html/nasaaccess_R.html
@@ -19,7 +19,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="2. NASAaccess Python Guide" href="nasaaccess_python.html" />
-    <link rel="prev" title="Welcome to NASAaccess’s documentation!" href="index.html" /> 
+    <link rel="prev" title="Welcome to NASAaccess’s documentation" href="index.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -100,7 +100,7 @@ <h2><span class="section-number">1.1. </span>Prerequisites<a class="headerlink"
 </div></blockquote>
 <div class="section" id="manual-creation-of-the-netrc-file">
 <h3><span class="section-number">1.1.1. </span>Manual creation of the <em>.netrc</em> file<a class="headerlink" href="#manual-creation-of-the-netrc-file" title="Permalink to this heading"></a></h3>
-<p>The <em>.netrc</em> file and the <em>_netrc</em> file (only for Windows OS machines) are generated automatically when installing the <em>NASAaccess</em> software package. However, if the user wants to create theses access files manually here are the steps needed.</p>
+<p>The <em>.netrc</em> file and the <em>_netrc</em> file (only for Windows OS machines) are generated automatically when installing the <em>NASAaccess</em> R software package. However, if the user wants to create theses access files manually here are the steps needed.</p>
 <ol class="arabic">
 <li><p>Define <cite>HOME</cite> variable in your Environment Variables by picking any directory you want to be referenced as your <cite>HOME</cite> directory. For convenient installation, the user should go with the machine default <cite>HOME</cite> directory. In many Winodws OS machines <cite>HOME</cite> directory is the user personal <cite>Documents</cite> folder (i.e., C:\Users\yourname\Documents).</p>
 <blockquote>
@@ -316,7 +316,7 @@ <h2><span class="section-number">1.3. </span>Getting Started with the NASAaccess
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to NASAaccess’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to NASAaccess’s documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="nasaaccess_python.html" class="btn btn-neutral float-right" title="2. NASAaccess Python Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/docs/_build/html/nasaaccess_tethys.html b/docs/_build/html/nasaaccess_tethys.html
@@ -119,8 +119,8 @@ <h2><span class="section-number">3.4. </span>Installation/Setup<a class="headerl
 <dt>EarthData:</dt><dd><p><strong>NASAaccess</strong> needs a user registration access with <a class="reference external" href="https://www.earthdata.nasa.gov/">Earthdata</a>. Users should set up a registration account(s) with Earthdata login as well as authorizing NASA GES DISC data access. Please refer to <a class="reference external" href="https://disc.gsfc.nasa.gov/data-access">https://disc.gsfc.nasa.gov/data-access</a> for further details.</p>
 <blockquote>
 <div><ul class="simple">
-<li><p>After registration with <a class="reference external" href="https://www.earthdata.nasa.gov/">Earthdata</a> <em>NASAaccess</em> software package users should create a reference file (<em>netrc</em>) with <a class="reference external" href="https://www.earthdata.nasa.gov/">Earthdata</a> credentials stored in it to streamline the retrieval access to <a class="reference external" href="https://www.nasa.gov/">NASA</a> servers.</p></li>
-<li><p>Creating the <em>.netrc</em> file at the user machine <em>Home</em> directory and storing the user <a class="reference external" href="https://www.nasa.gov/">NASA</a> <a class="reference external" href="https://disc.gsfc.nasa.gov/">GES DISC</a> logging information in it is needed to execute the <em>NASAaccess</em> package commands. Accessing data at NASA servers is further explained at <a class="reference external" href="https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget">https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget</a>. The manual steps for creating <em>.netrc</em> file has been discussed in <a class="reference external" href="nasaaccess_R.html">NASAaccess R package installation</a>.</p></li>
+<li><p>After registration with <a class="reference external" href="https://www.earthdata.nasa.gov/">Earthdata</a> <em>NASAaccess</em> software package users should create a reference file (<em>.netrc</em>) with <a class="reference external" href="https://www.earthdata.nasa.gov/">Earthdata</a> credentials stored in it to streamline the retrieval access from <a class="reference external" href="https://www.nasa.gov/">NASA</a> servers.</p></li>
+<li><p>Creating the <em>.netrc</em> file at the user <em>Home</em> directory and storing the user <a class="reference external" href="https://www.nasa.gov/">NASA</a> <a class="reference external" href="https://disc.gsfc.nasa.gov/">GES DISC</a> logging information in it is needed to execute the <em>NASAaccess</em> package commands. Accessing data at NASA servers is further explained at <a class="reference external" href="https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget">https://wiki.earthdata.nasa.gov/display/EL/How+To+Access+Data+With+cURL+And+Wget</a>. The manual steps for creating <em>.netrc</em> file has been discussed in <a class="reference external" href="nasaaccess_R.html">NASAaccess R package installation</a>.</p></li>
 </ul>
 </div></blockquote>
 </dd>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv