update doc

IPGP · Apr 22, 2024 · 45baaff · 45baaff
1 parent 865d777
commit 45baaff
Show file tree

Hide file tree

Showing 23 changed files with 45 additions and 24 deletions.
diff --git a/docs/_sources/getting_started.rst.txt b/docs/_sources/getting_started.rst.txt
@@ -37,8 +37,11 @@ To get the latest working version you can install directly the GitHub-hosted ver
 clone and manually install from GitHub
 --------------------------------------
 
-You can manually fork and clone the GitHub repository
-``https://github.com/IPGP/geodezyx/``
+You can manually fork and/or clone the GitHub repository
+([https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/))
+using your favorite flavor:
+* SSH: ``git clone [email protected]:IPGP/geodezyx.git``
+* https: ``git clone https://github.com/IPGP/geodezyx.git``
 
 and install the Toolbox you downloaded with ``python setup.py install``
 

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -57,7 +57,7 @@ GNU General Public License, Version 3, 29 June 2007
 
 Copyright © 2019 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany (Pierre Sakic, Gustavo Mansur, and Kitpracha "Na" Chaiyaporn, Valérie Ballu)
 
-geodezyx is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodeZYX toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+The geodezyx toolbox is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodezyx toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
 

diff --git a/docs/getting_started.html b/docs/getting_started.html
@@ -111,8 +111,11 @@ <h4>Full installation (for sudoers/advanced users)<a class="headerlink" href="#f
 </section>
 <section id="clone-and-manually-install-from-github">
 <h3>clone and manually install from GitHub<a class="headerlink" href="#clone-and-manually-install-from-github" title="Link to this heading"></a></h3>
-<p>You can manually fork and clone the GitHub repository
-<code class="docutils literal notranslate"><span class="pre">https://github.com/IPGP/geodezyx/</span></code></p>
+<p>You can manually fork and/or clone the GitHub repository
+([<a class="reference external" href="https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/">https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/</a>))
+using your favorite flavor:
+* SSH: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git&#64;github.com:IPGP/geodezyx.git</span></code>
+* https: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/IPGP/geodezyx.git</span></code></p>
 <p>and install the Toolbox you downloaded with <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">install</span></code></p>
 <p>Alternatively, you can also add the <code class="docutils literal notranslate"><span class="pre">geodezyx</span></code> folder in your <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> (for experimented users)</p>
 </section>

diff --git a/docs/index.html b/docs/index.html
@@ -105,7 +105,7 @@ <h2>Authors<a class="headerlink" href="#authors" title="Link to this heading">
 <h2>License<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
 <p>GNU General Public License, Version 3, 29 June 2007</p>
 <p>Copyright © 2019 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany (Pierre Sakic, Gustavo Mansur, and Kitpracha “Na” Chaiyaporn, Valérie Ballu)</p>
-<p>geodezyx is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodeZYX toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
+<p>The geodezyx toolbox is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodezyx toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
 <p>You should have received a copy of the GNU General Public License along with this program. If not, see <a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
 </section>
 <section id="indices-and-tables">

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docsrc/build/.doctrees/environment.pickle b/docsrc/build/.doctrees/environment.pickle
diff --git a/docsrc/build/.doctrees/getting_started.doctree b/docsrc/build/.doctrees/getting_started.doctree
diff --git a/docsrc/build/.doctrees/index.doctree b/docsrc/build/.doctrees/index.doctree
diff --git a/docsrc/build/_sources/getting_started.rst.txt b/docsrc/build/_sources/getting_started.rst.txt
@@ -37,8 +37,11 @@ To get the latest working version you can install directly the GitHub-hosted ver
 clone and manually install from GitHub
 --------------------------------------
 
-You can manually fork and clone the GitHub repository
-``https://github.com/IPGP/geodezyx/``
+You can manually fork and/or clone the GitHub repository
+([https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/))
+using your favorite flavor:
+* SSH: ``git clone [email protected]:IPGP/geodezyx.git``
+* https: ``git clone https://github.com/IPGP/geodezyx.git``
 
 and install the Toolbox you downloaded with ``python setup.py install``
 

diff --git a/docsrc/build/_sources/index.rst.txt b/docsrc/build/_sources/index.rst.txt
@@ -57,7 +57,7 @@ GNU General Public License, Version 3, 29 June 2007
 
 Copyright © 2019 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany (Pierre Sakic, Gustavo Mansur, and Kitpracha "Na" Chaiyaporn, Valérie Ballu)
 
-geodezyx is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodeZYX toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+The geodezyx toolbox is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodezyx toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
 

diff --git a/docsrc/build/doctrees/environment.pickle b/docsrc/build/doctrees/environment.pickle
diff --git a/docsrc/build/doctrees/getting_started.doctree b/docsrc/build/doctrees/getting_started.doctree
diff --git a/docsrc/build/doctrees/index.doctree b/docsrc/build/doctrees/index.doctree
diff --git a/docsrc/build/getting_started.html b/docsrc/build/getting_started.html
@@ -111,8 +111,11 @@ <h4>Full installation (for sudoers/advanced users)<a class="headerlink" href="#f
 </section>
 <section id="clone-and-manually-install-from-github">
 <h3>clone and manually install from GitHub<a class="headerlink" href="#clone-and-manually-install-from-github" title="Link to this heading"></a></h3>
-<p>You can manually fork and clone the GitHub repository
-<code class="docutils literal notranslate"><span class="pre">https://github.com/IPGP/geodezyx/</span></code></p>
+<p>You can manually fork and/or clone the GitHub repository
+([<a class="reference external" href="https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/">https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/</a>))
+using your favorite flavor:
+* SSH: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git&#64;github.com:IPGP/geodezyx.git</span></code>
+* https: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/IPGP/geodezyx.git</span></code></p>
 <p>and install the Toolbox you downloaded with <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">install</span></code></p>
 <p>Alternatively, you can also add the <code class="docutils literal notranslate"><span class="pre">geodezyx</span></code> folder in your <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> (for experimented users)</p>
 </section>

diff --git a/docsrc/build/html/_sources/getting_started.rst.txt b/docsrc/build/html/_sources/getting_started.rst.txt
@@ -37,8 +37,11 @@ To get the latest working version you can install directly the GitHub-hosted ver
 clone and manually install from GitHub
 --------------------------------------
 
-You can manually fork and clone the GitHub repository
-``https://github.com/IPGP/geodezyx/``
+You can manually fork and/or clone the GitHub repository
+([https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/))
+using your favorite flavor:
+* SSH: ``git clone [email protected]:IPGP/geodezyx.git``
+* https: ``git clone https://github.com/IPGP/geodezyx.git``
 
 and install the Toolbox you downloaded with ``python setup.py install``
 

diff --git a/docsrc/build/html/_sources/index.rst.txt b/docsrc/build/html/_sources/index.rst.txt
@@ -57,7 +57,7 @@ GNU General Public License, Version 3, 29 June 2007
 
 Copyright © 2019 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany (Pierre Sakic, Gustavo Mansur, and Kitpracha "Na" Chaiyaporn, Valérie Ballu)
 
-geodezyx is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodeZYX toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+The geodezyx toolbox is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodezyx toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
 

diff --git a/docsrc/build/html/getting_started.html b/docsrc/build/html/getting_started.html
@@ -111,8 +111,11 @@ <h4>Full installation (for sudoers/advanced users)<a class="headerlink" href="#f
 </section>
 <section id="clone-and-manually-install-from-github">
 <h3>clone and manually install from GitHub<a class="headerlink" href="#clone-and-manually-install-from-github" title="Link to this heading"></a></h3>
-<p>You can manually fork and clone the GitHub repository
-<code class="docutils literal notranslate"><span class="pre">https://github.com/IPGP/geodezyx/</span></code></p>
+<p>You can manually fork and/or clone the GitHub repository
+([<a class="reference external" href="https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/">https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/</a>))
+using your favorite flavor:
+* SSH: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git&#64;github.com:IPGP/geodezyx.git</span></code>
+* https: <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/IPGP/geodezyx.git</span></code></p>
 <p>and install the Toolbox you downloaded with <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">install</span></code></p>
 <p>Alternatively, you can also add the <code class="docutils literal notranslate"><span class="pre">geodezyx</span></code> folder in your <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> (for experimented users)</p>
 </section>

diff --git a/docsrc/build/html/index.html b/docsrc/build/html/index.html
@@ -105,7 +105,7 @@ <h2>Authors<a class="headerlink" href="#authors" title="Link to this heading">
 <h2>License<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
 <p>GNU General Public License, Version 3, 29 June 2007</p>
 <p>Copyright © 2019 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany (Pierre Sakic, Gustavo Mansur, and Kitpracha “Na” Chaiyaporn, Valérie Ballu)</p>
-<p>geodezyx is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodeZYX toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
+<p>The geodezyx toolbox is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodezyx toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
 <p>You should have received a copy of the GNU General Public License along with this program. If not, see <a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
 </section>
 <section id="indices-and-tables">

diff --git a/docsrc/build/html/searchindex.js b/docsrc/build/html/searchindex.js
diff --git a/docsrc/build/index.html b/docsrc/build/index.html
@@ -105,7 +105,7 @@ <h2>Authors<a class="headerlink" href="#authors" title="Link to this heading">
 <h2>License<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
 <p>GNU General Public License, Version 3, 29 June 2007</p>
 <p>Copyright © 2019 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany (Pierre Sakic, Gustavo Mansur, and Kitpracha “Na” Chaiyaporn, Valérie Ballu)</p>
-<p>geodezyx is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodeZYX toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
+<p>The geodezyx toolbox is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodezyx toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
 <p>You should have received a copy of the GNU General Public License along with this program. If not, see <a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
 </section>
 <section id="indices-and-tables">

diff --git a/docsrc/build/searchindex.js b/docsrc/build/searchindex.js
diff --git a/docsrc/source/getting_started.rst b/docsrc/source/getting_started.rst
@@ -37,8 +37,11 @@ To get the latest working version you can install directly the GitHub-hosted ver
 clone and manually install from GitHub
 --------------------------------------
 
-You can manually fork and clone the GitHub repository
-``https://github.com/IPGP/geodezyx/``
+You can manually fork and/or clone the GitHub repository
+([https://github.com/IPGP/geodezyx/](https://github.com/IPGP/geodezyx/))
+using your favorite flavor:
+* SSH: ``git clone [email protected]:IPGP/geodezyx.git``
+* https: ``git clone https://github.com/IPGP/geodezyx.git``
 
 and install the Toolbox you downloaded with ``python setup.py install``
 

diff --git a/docsrc/source/index.rst b/docsrc/source/index.rst
@@ -57,7 +57,7 @@ GNU General Public License, Version 3, 29 June 2007
 
 Copyright © 2019 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany (Pierre Sakic, Gustavo Mansur, and Kitpracha "Na" Chaiyaporn, Valérie Ballu)
 
-geodezyx is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodeZYX toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+The geodezyx toolbox is a free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. The geodezyx toolbox is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.