Fix documentation glitches

CONTRIBUTING.rst

@@ -24,7 +24,7 @@ So all code changes happen through Pull Requests (PRs).
 
 Before adding your contribution, please take a moment to read through the following sections:
 
-- The :ref:`Installation for contributors <installation_contributor>` help you to set up the developing environment and the pre-commit hooks.
+- The `Installation for contributors <https://disdrodb.readthedocs.io/en/latest/installation.html#installation-for-contributors>`__ help you to set up the developing environment and the pre-commit hooks.
 - The section `Contributing process <#contributing-process>`__ provides you with a brief overview of the steps that each DISDRODB developer must follow to contribute to the repository.
 - The `Code review checklist <#code-review-checklist>`__ enable to speed up the code review process.
 - The `Code of conduct <https://github.com/ltelab/disdrodb/blob/main/CODE_OF_CONDUCT.md>`__ details the expected behavior of all contributors.
@@ -80,15 +80,15 @@ Here is a brief overview of the steps that each DISDRODB developer must follow t
 6. Create a new Pull Request in GitHub.
 
 
-.. image:: /static/collaborative_process.png
+.. image:: https://github.com/ltelab/disdrodb/blob/main/docs/source/static/collaborative_process.png?raw=true
 
 
 1. Fork the repository and install the development environment
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you do not have a GitHub account yet, please create one `here <https://github.com/join>`__.
 If you do not have yet Git installed on your computer, please install it following `these instructions <https://github.com/git-guides/install-git>`__.
-Then, please follow the guidelines in the :ref:`Installation for contributors <installation_contributor>` section
+Then, please follow the guidelines in the `Installation for contributors <https://disdrodb.readthedocs.io/en/latest/installation.html#installation-for-contributors>`__ section
 to create the local copy of the disdrodb repository, set up the developing environment and the pre-commit hooks.
 
 Once you have have a local copy of the disdrodb repository on your machine, you are ready to
@@ -184,9 +184,9 @@ extension to automatically create such preformatted docstring.
 
 You should configure VS code as follow :
 
-
-.. image:: /static/vs_code_settings.png
-
+.. image:: https://github.com/ltelab/disdrodb/blob/main/docs/source/static/vs_code_settings.png?raw=true
+   :alt: VS Code Settings
+   :align: center
 
 The convention we adopt for our docstrings is the numpydoc string convention.
 
@@ -267,7 +267,7 @@ The following tools are used:
 
 For contributors interested in running the tests locally:
 
-1. Ensure you have the :ref:`development environment <installation_standard>` correctly set up.
+1. Ensure you have the `development environment <https://disdrodb.readthedocs.io/en/latest/installation.html#installation-for-contributors>`__ correctly set up.
 2. Navigate to the disdrodb root directory.
 3. Execute the following command to run the entire test suite:
 

README.md

@@ -50,9 +50,7 @@ Let's start by travel to the directory where you want to store the DISDRODB Data
 Then clone the DISDRODB Metadata Archive repository with:
 
 ```bash
-
-   git clone https://github.com/ltelab/disdrodb-data.git
-
+git clone https://github.com/ltelab/disdrodb-data.git
 ```
 
 This will create a directory called ``disdrodb-data``, which is ready to be filled with data from the DISDRODB Decentralized Data Archive.
@@ -62,37 +60,29 @@ But before starting to download some data, we need to specify the location of th
 You can specify once forever the default DISDRODB Local Archive directory by running in python:
 
 ```python
-
-   import disdrodb
-   base_dir = "<path_to>/disdrodb-data/DISDRODB>"
-   disdrodb.define_configs(base_dir=base_dir)
-
+import disdrodb
+base_dir = "<path_to>/disdrodb-data/DISDRODB>"
+disdrodb.define_configs(base_dir=base_dir)
 ```
 
 or set up the (temporary) environment variable `DISDRODB_BASE_DIR` in your terminal with:
 
 ```bash
-
-   export DISDRODB_BASE_DIR="<path_to>/disdrodb-data/DISDRODB>"
-
+export DISDRODB_BASE_DIR="<path_to>/disdrodb-data/DISDRODB>"
 ```
 
 ### 📥 Download the DISDRODB raw data
 
 To download all data stored into the DISDRODB Decentralized Data Archive, you just have to run the following command:
 
 ```bash
-
-   disdrodb_download_archive
-
+disdrodb_download_archive
 ```
 
 If you aims to download data from a specific data source (i.e. EPFL), type:
 
 ```bash
-
-   disdrodb_download_archive --data-sources EPFL
-
+disdrodb_download_archive --data-sources EPFL
 ```
 
 Type `disdrodb_download_archive --help` to see further options.
@@ -102,9 +92,7 @@ Type `disdrodb_download_archive --help` to see further options.
 If you want to convert all stations raw data into standardized netCDF4 files, run the following command in the terminal:
 
 ```bash
-
-   disdrodb_run_l0
-
+disdrodb_run_l0
 ```
 
 Type `disdrodb_run_l0 --help` to see further options.
@@ -124,9 +112,7 @@ is hosted on GitHub at [https://github.com/ltelab/disdrodb-data](https://github.
 DISDRODB can be installed from PyPI with pip:
 
   ```bash
-
   pip install disdrodb
-
   ```
 
 ## 💭 Feedback and Contributing Guidelines

docs/source/installation.rst

@@ -143,7 +143,7 @@ Install the disdrodb package in editable mode by executing the following command
 
 .. code-block:: bash
 
-	pip install -e ".[dev]
+	pip install -e ".[dev]"
 
 
 Install pre-commit code quality checks