From ffd11d47fd43ac7a3578e970786d67bb8508f97e Mon Sep 17 00:00:00 2001 From: ghiggi Date: Thu, 8 Feb 2024 11:09:09 +0100 Subject: [PATCH] Fix documentation glitches --- CONTRIBUTING.rst | 14 +++++++------- README.md | 30 ++++++++---------------------- docs/source/installation.rst | 2 +- 3 files changed, 16 insertions(+), 30 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1f60d4db..ae672ff5 100644 --- a/CONTRIBUTING.rst +++ b/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 ` help you to set up the developing environment and the pre-commit hooks. +- The `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 `__ details the expected behavior of all contributors. @@ -80,7 +80,7 @@ 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 @@ -88,7 +88,7 @@ Here is a brief overview of the steps that each DISDRODB developer must follow t If you do not have a GitHub account yet, please create one `here `__. If you do not have yet Git installed on your computer, please install it following `these instructions `__. -Then, please follow the guidelines in the :ref:`Installation for contributors ` section +Then, please follow the guidelines in the `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 ` correctly set up. +1. Ensure you have the `development environment `__ correctly set up. 2. Navigate to the disdrodb root directory. 3. Execute the following command to run the entire test suite: diff --git a/README.md b/README.md index 33d8f0b7..8380e487 100644 --- a/README.md +++ b/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,19 +60,15 @@ 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 = "/disdrodb-data/DISDRODB>" - disdrodb.define_configs(base_dir=base_dir) - +import disdrodb +base_dir = "/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="/disdrodb-data/DISDRODB>" - +export DISDRODB_BASE_DIR="/disdrodb-data/DISDRODB>" ``` ### 📥 Download the DISDRODB raw data @@ -82,17 +76,13 @@ or set up the (temporary) environment variable `DISDRODB_BASE_DIR` in your termi 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 diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 08ca4875..20e3a759 100644 --- a/docs/source/installation.rst +++ b/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