From 6cada35855916d758c03cfd093892122aaf3cbd7 Mon Sep 17 00:00:00 2001 From: Rufai Omowunmi Balogun <rbalogun@eurac.edu> Date: Thu, 26 Oct 2023 19:39:46 +0200 Subject: [PATCH] update installation guide --- docs/source/guide/installation.rst | 8 ++++++-- docs/source/index.rst | 6 +++--- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/source/guide/installation.rst b/docs/source/guide/installation.rst index 852db97..c11d586 100644 --- a/docs/source/guide/installation.rst +++ b/docs/source/guide/installation.rst @@ -3,7 +3,7 @@ Installation ============ The smodex package is distributed via the Python Package Index and also available on the -[development repo](https://gitlab.inf.unibz.it/earth_observation_public/smodex). To enable +`development repo`_. To enable the full functionalities, install also the `cdsapi` @@ -22,7 +22,7 @@ if you do not have pip installed yet. Option 2: Clone the repository ------------------------------ The latest development version of the smode package is available on the -[GitLab repo](https://gitlab.inf.unibz.it/earth_observation_public/smodex). +`GitLab repo`_. .. caution:: @@ -34,3 +34,7 @@ The latest development version of the smode package is available on the git clone https://gitlab.inf.unibz.it/earth_observation_public/smodex cd smodex python setup.py install + + +.. _development repo: https://gitlab.inf.unibz.it/earth_observation_public/smodex +.. _GitLab repo : https://gitlab.inf.unibz.it/earth_observation_public/smodex diff --git a/docs/source/index.rst b/docs/source/index.rst index 5d1f6d6..658cce4 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -31,7 +31,7 @@ Features - Computation of climatological statistics at different rolling means and time-scale, - Computes anomalies at different time-scales, - Supports Python versions 3.7+ -- Released under the `MIT No Attribution license` +- Released under the `MIT No Attribution license`_. User guide @@ -42,7 +42,7 @@ A step by step guide on getting started with smodex package .. toctree:: :maxdepth: 2 - + guide/installation.rst guide/quickstart.rst guide/downloader.rst @@ -60,4 +60,4 @@ smodex license -------------- the smodex package is release under the MIT No-Attribution license. -.. _`MIT license`:https://gitlab.inf.unibz.it/earth_observation_public/smodex/-/blob/master/LICENSE?ref_type=heads +.. _MIT No Attribution license: https://gitlab.inf.unibz.it/earth_observation_public/smodex/-/blob/master/LICENSE?ref_type=heads -- GitLab