Skip to content

Commit

Permalink
Fix sphinx issues
Browse files Browse the repository at this point in the history
  • Loading branch information
@ghiggi
ghiggi committed Nov 7, 2023
1 parent 075d5a3 commit 6d0dbcf
Show file tree
Hide file tree
Showing 7 changed files with 75 additions and 75 deletions.
50 changes: 22 additions & 28 deletions CONTRIBUTING.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ Here is a brief overview of the steps that each DISDRODB developer must follow t


1. Fork the repository
~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~

Once you have set the development environment (see `Setting up the development environment`_), the next step is creating
Once you have set the development environment (see `Set up the development environment`_), the next step is creating
your local copy of the repository, where you will commit your
modifications. The steps to follow are:

Expand Down Expand Up @@ -271,9 +271,7 @@ To run `Black` locally :
.. note::
To maintain consistency, make sure to stick to the version defined in the
`.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ file.
This version will be used in the CI.
To maintain consistency, make sure to stick to the version defined in the `.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ file. This version will be used in the CI.



Expand All @@ -287,9 +285,7 @@ To run `Ruff` locally :
.. note::
To maintain consistency, make sure to stick to the version and the rule configuration defined in the
`.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ file.
This version will be used in the CI.
To maintain consistency, make sure to stick to the version and the rule configuration defined in the `.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ file. This version will be used in the CI.



Expand All @@ -303,28 +299,26 @@ To run `Codespell` locally :
.. note::
To maintain consistency, make sure to stick to the version and the rule configuration defined in the
`.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ file.
This version will be used in the CI.
To maintain consistency, make sure to stick to the version and the rule configuration defined in the `.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ file. This version will be used in the CI.


In the table below, some CI tool are mentioned for your information, but does not need to be installed on your computer.
They are automatically run when you push your changes to the main repository via a GitHub Pull Request.


+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| Tool | Aim |
+===============================================================================================+==================================================================+
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit (as defined in `.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ ) |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| `CodeBeat <https://codebeat.co/>`__ | Automated code review and analysis tools |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| `CodeScene <https://codescene.com/>`__ | Automated code review and analysis tools |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| `CodeFactor <https://www.codefactor.io/>`__ | Automated code review and analysis tools |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| `Snyk Code <https://snyk.io/product/snyk-code/>`__ | Automated code security checks |
+-----------------------------------------------------------------------------------------------+------------------------------------------------------------------+
+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| Tool | Aim |
+====================================================+===================================================================================================================================+
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit (as defined in `.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ ) |
+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| `CodeBeat <https://codebeat.co/>`__ | Automated code review and analysis tools |
+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| `CodeScene <https://codescene.com/>`__ | Automated code review and analysis tools |
+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| `CodeFactor <https://www.codefactor.io/>`__ | Automated code review and analysis tools |
+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| `Snyk Code <https://snyk.io/product/snyk-code/>`__ | Automated code security checks |
+----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+



Expand Down Expand Up @@ -431,17 +425,17 @@ a Pull Request (PR) to the DISDRODB main branch.
- If adding a new feature:

- Add accompanying test case.
- Provide a convincing reason to add this feature.
- Ideally, you should open a suggestion issue first and have it approved before working on it.
- Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
- Optionally, you can also present your issue in the repository `Discussions <https://github.com/ltelab/disdrodb/discussions>`__.

- If fixing bug:

- If you are resolving a special issue, add ``(fix #xxxx)`` in your PR title for a better release log.
For example: ``Update L0 encoding compression (fix #3899)``.
- If you are resolving a special issue, add ``(fix #xxxx)`` in your PR title for a better release log. For example: ``Update L0 encoding compression (fix #3899)``.
- Provide a detailed description of the bug in the PR.
- Add appropriate test coverage if applicable.



.. _section-1:

Code review checklist
Expand Down
1 change: 0 additions & 1 deletion docs/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@
html_theme_options = {
"repository_url": "https://github.com/ltelab/disdrodb",
"use_repository_button": True,
"tocdepth": 2, # Adjust the depth as needed
}

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down
14 changes: 8 additions & 6 deletions docs/source/contribute_data.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Data transfer upload and download schema:
.. image:: /static/transfer.png


Update the DISDRODB metadata archive
----------------------------------------
Add stations information to the DISDRODB metadata archive
----------------------------------------------------------

Do you want to contribute to the project with your own data? Great! Just
follow these steps:
Expand Down Expand Up @@ -122,8 +122,9 @@ To do so, first make a copy of the DISDRODB metadata archive you just edited, in

Then, run the following command to download the data you just uploaded:

.. code:: bash
export DISDRODB_BASE_DIR="<the_path_to_a_copy_of_the_disdrodb-data_you_edited/DISDRODB"
.. code::
export DISDRODB_BASE_DIR="<the_path_to_a_copy_of_the_disdrodb-data_you_edited>/DISDRODB"
disdrodb_download_archive --data_sources <your_data_source> --campaign_names <your_new_campaign> --force true
::note
Expand All @@ -134,8 +135,9 @@ If the download is successful, and you also already implemented the DISDRODB rea

To do so, run the following command:

.. code:: bash
export DISDRODB_BASE_DIR="<the_path_to_a_copy_of_the_disdrodb-data_you_edited/DISDRODB"
.. code::
export DISDRODB_BASE_DIR="<the_path_to_a_copy_of_the_disdrodb-data_you_edited>/DISDRODB"
disdrodb_run_l0 --data_sources <your_data_source> --campaign_names <your_new_campaign>
::note
Expand Down
15 changes: 6 additions & 9 deletions docs/source/l0_processing.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ Launch DISDRODB L0 processing for a specific station
======================================================


Command line solution
~~~~~~~~~~~~~~~~~~~~~~
**Command line solution**


.. code-block:: bash
Expand All @@ -28,9 +27,8 @@ Example:
Type ``disdrodb_run_l0_station --help`` in the terminal to get more information on the possible parameters.


Pythonic solution
~~~~~~~~~~~~~~~~~~~

**Pythonic solution**


.. code-block::
Expand Down Expand Up @@ -103,8 +101,8 @@ For example:
- if only the ``--station_names`` argument is specified, DISDRODB will process only the specified stations.


Command line solution
~~~~~~~~~~~~~~~~~~~~~~
**Command line solution**



.. code-block:: bash
Expand All @@ -127,8 +125,7 @@ To specify multiple campaigns you can do the follow
Type ``disdrodb_run_l0 --help`` in the terminal to get more information on the possible parameters.


Pythonic solution
~~~~~~~~~~~~~~~~~~~
**Pythonic solution**


.. code-block::
Expand Down
7 changes: 4 additions & 3 deletions docs/source/maintainers_guidelines.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Currently, on each Pull Request, GitHub Actions are configured as follow:
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `Ruff <https://github.com/charliermarsh/ruff>`__ | Python linter | |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit as defined in `.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ | | |
| `pre-commit.ci <https://pre-commit.ci/>`__ | Run pre-commit as defined in `.pre-commit-config.yaml <https://github.com/ltelab/disdrodb/blob/main/.pre-commit-config.yaml>`_ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| Coverage <https://coverage.readthedocs.io/>`__ | Measure the code coverage of the project's unit tests | |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
Expand All @@ -153,9 +153,10 @@ Currently, on each Pull Request, GitHub Actions are configured as follow:
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `CodeBeat <https://codebeat.co/>`__ | Automated code review and analysis tools | `disdrodb <https://codebeat.co/projects/github.aaakk.us.kg-ltelab-disdrodb-main/security_issues>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `CodeScene <https://codescene.com/>`__ | Automated code review and analysis tools | `disdrodb <https://codescene.io/projects/36773`__ |
| `CodeScene <https://codescene.com/>`__ | Automated code review and analysis tools | `disdrodb <https://codescene.io/projects/36773>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `CodeFactor <https://www.codefactor.io/>`__ | Automated code review and analysis tools | `disdrodb <https://www.codefactor.io/repository/github/ltelab/disdrodb>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| `Snyk Code <https://snyk.io/product/snyk-code/>`__ | Automated code security checks | `disdrodb <https://app.snyk.io/org/ghiggi/project/57219345-56bd-4fbb-b6eb-2a8d955f9924 `__ |
| `Snyk Code <https://snyk.io/product/snyk-code/>`__ | Automated code security checks | `disdrodb <https://app.snyk.io/org/ghiggi/project/57219345-56bd-4fbb-b6eb-2a8d955f9924>`__ |
+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------------------------------------------------------------------------+

Loading

0 comments on commit 6d0dbcf

Please sign in to comment.