[CC] documentation folder becomes docs to follow github standards

Eomys · Feb 23, 2022 · 978490b · 978490b
1 parent ff3bd0c
commit 978490b
Show file tree

Hide file tree

Showing 15 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Besides the metrics, sound quality studies requires several tool like audio sign
 ## Objectives
 
 The objective of MOSQITO is therefore to provide a unified and modular development framework of key sound quality tools (including key SQ metrics) with open-source object-oriented technologies, favoring reproducible science and efficient shared scripting among engineers, teachers and researchers
-community. The development roadmap of the project is presented in more details in the [scope section](./documentation/scope.md) of the documentation. 
+community. The development roadmap of the project is presented in more details in the [scope section](./docs/scope.md) of the documentation. 
 
 It is written in Python, one of the most popular free programming language in the scientific computing community. It is meant to be highly documented (use of Jupyter notebooks, tutorials) and validated with reference sound samples and scientific publications.
 
@@ -33,7 +33,7 @@ It is written in Python, one of the most popular free programming language in th
 
 ## Documentation
 
-Tutorials are available in the [tutorials](./tutorials/) folder. Documentation and validation of the MOSQITO functions are available in the [documentation](./documentation/) folder.
+Tutorials are available in the [tutorials](./tutorials/) folder. Documentation and validation of the MOSQITO functions are available in the [documentation](./docs/) folder.
 
 ## Getting MOSQITO
 MOSQITO is available on [pip](https://pypi.org/project/pip/). Simply type in a shell the following command:

diff --git a/documentation/architecture.md → docs/architecture.md b/documentation/architecture.md → docs/architecture.md
diff --git a/documentation/loudness_ecma.md → docs/loudness_ecma.md b/documentation/loudness_ecma.md → docs/loudness_ecma.md
diff --git a/documentation/loudness_zwst.md → docs/loudness_zwst.md b/documentation/loudness_zwst.md → docs/loudness_zwst.md
diff --git a/documentation/loudness_zwtv.md → docs/loudness_zwtv.md b/documentation/loudness_zwtv.md → docs/loudness_zwtv.md
diff --git a/documentation/readme.md → docs/readme.md b/documentation/readme.md → docs/readme.md
diff --git a/documentation/roughness_danielweber.md → docs/roughness_danielweber.md b/documentation/roughness_danielweber.md → docs/roughness_danielweber.md
diff --git a/documentation/scope.md → docs/scope.md b/documentation/scope.md → docs/scope.md
diff --git a/documentation/sharpness_din.md → docs/sharpness_din.md b/documentation/sharpness_din.md → docs/sharpness_din.md
diff --git a/...ntation/tone-to-noise-prominence-ratio.md → docs/tone-to-noise-prominence-ratio.md b/...ntation/tone-to-noise-prominence-ratio.md → docs/tone-to-noise-prominence-ratio.md
diff --git a/tutorials/tuto_TNR_PR.ipynb b/tutorials/tuto_TNR_PR.ipynb
@@ -69,7 +69,7 @@
     "- \"method\", that can be set to \"tnr\", \"pr\", or \"all\" to compute both,\n",
     "- \"prominence\", that indicates if the outputs are either only the prominent values or all tonal values.\n",
     "\n",
-    "The tonal candidates are automatically detected using the Sottek method (see the corresponding [documentation](../documentation/tone-to-noise-prominence-ratio.md) for more information) "
+    "The tonal candidates are automatically detected using the Sottek method (see the corresponding [documentation](../docs/tone-to-noise-prominence-ratio.md) for more information) "
    ]
   },
   {

diff --git a/tutorials/tuto_loudness_zwst.ipynb b/tutorials/tuto_loudness_zwst.ipynb
@@ -16,7 +16,7 @@
    "source": [
     "\n",
     "# How to compute acoustic Loudness according to Zwicker method for stationary signals\n",
-    "This tutorial explains how to use MOSQITO to compute the acoustic loudness of a signal according to the Zwicker method for stationary signals (as per ISO 532-1 section 5). For more information on the implementation and validation of the metric, you can refer to the [documentation](../documentation/loudness_zwst.md).\n",
+    "This tutorial explains how to use MOSQITO to compute the acoustic loudness of a signal according to the Zwicker method for stationary signals (as per ISO 532-1 section 5). For more information on the implementation and validation of the metric, you can refer to the [documentation](../docs/loudness_zwst.md).\n",
     "\n",
     "The following commands are used to import the necessary functions."
    ]

diff --git a/tutorials/tuto_loudness_zwtv.ipynb b/tutorials/tuto_loudness_zwtv.ipynb
@@ -17,7 +17,7 @@
     "\n",
     "\n",
     "# How to compute acoustic Loudness according to Zwicker method for time-varying signals\n",
-    "This tutorial explains how to use MOSQITO to compute the acoustic loudness of a signal according to the Zwicker method for time_varying signals (as per ISO 532-1 section 6). For more information on the implementation and validation of the metric, you can refer to the [documentation](../documentation/loudness_zwtv.md).\n",
+    "This tutorial explains how to use MOSQITO to compute the acoustic loudness of a signal according to the Zwicker method for time_varying signals (as per ISO 532-1 section 6). For more information on the implementation and validation of the metric, you can refer to the [documentation](../docs/loudness_zwtv.md).\n",
     "\n",
     "The following commands are used to import the necessary functions."
    ]

diff --git a/tutorials/tuto_roughness_danielweber.ipynb b/tutorials/tuto_roughness_danielweber.ipynb
@@ -64,7 +64,7 @@
     "The acoustic Roughness is computed using the following command line. The function takes 1 input argument \"overlap\" that indicates the overlapping coefficient for the time windows of 200ms (default is 0.5).\n",
     "\n",
     "\n",
-    "The roughness is computed according to the Daniel and Weber method (see the corresponding [documentation](../documentation/roughness.md) for more information) "
+    "The roughness is computed according to the Daniel and Weber method (see the corresponding [documentation](../docs/roughness.md) for more information) "
    ]
   },
   {

diff --git a/tutorials/tuto_sharpness_din.ipynb b/tutorials/tuto_sharpness_din.ipynb
@@ -56,7 +56,7 @@
     "- \"method\", that can be set to \"din\", \"bismarck\", \"aures\" or \"fastl\" depending on the computation method chosen,\n",
     "- \"skip\", that corresponds to the cut of the transient effect at the beginning of the signal.\n",
     "\n",
-    "The Loudness to be weighted is automatically computed by using the Zwicker method (see the corresponding [documentation](../documentation/loudness-time-varying.md) for more information) "
+    "The Loudness to be weighted is automatically computed by using the Zwicker method (see the corresponding [documentation](../docs/loudness-time-varying.md) for more information) "
    ]
   },
   {
-Original file line number
+Diff line change
@@ Expand Up / @@ -64,7 +64,7 @@ @@
         "The acoustic Roughness is computed using the following command line. The function takes 1 input argument \"overlap\" that indicates the overlapping coefficient for the time windows of 200ms (default is 0.5).\n",
         "\n",
         "\n",
-        "The roughness is computed according to the Daniel and Weber method (see the corresponding [documentation](../documentation/roughness.md) for more information) "
+        "The roughness is computed according to the Daniel and Weber method (see the corresponding [documentation](../docs/roughness.md) for more information) "
        ]
       },
       {
@@ Expand Down @@