renamed getting_started -> gettingstarted

CONTRIBUTING.md

@@ -5,7 +5,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
 # Development Environment
-We recommend a virtual python environment for development, a more detailed description of the setup process can be found in the [docs](https://rdm-software.pages.ufz.de/saqc/getting_started/InstallationGuide.html#set-up-a-virtual-environment).
+We recommend a virtual python environment for development, a more detailed description of the setup process can be found in the [docs](https://rdm-software.pages.ufz.de/saqc/gettingstarted/InstallationGuide.html#set-up-a-virtual-environment).
 
 # Testing
 SaQC comes with an extensive test suite based on [pytest](https://docs.pytest.org/en/latest/).

README.md

@@ -40,7 +40,7 @@ can be installed using [pip](https://pip.pypa.io/en/stable/):
 ```sh
 python -m pip install saqc
 ```
-For a more detailed installion guide, see the [installation guide](https://rdm-software.pages.ufz.de/saqc/getting_started/InstallationGuide.html).
+For a more detailed installion guide, see the [installation guide](https://rdm-software.pages.ufz.de/saqc/gettingstarted/InstallationGuide.html).
 
 ## Usage
 
@@ -106,7 +106,7 @@ saqc = (saqc
 ```
 
 A more detailed description of the Python API is available in the 
-[respective section](https://rdm-software.pages.ufz.de/saqc/getting_started/TutorialAPI.html)
+[respective section](https://rdm-software.pages.ufz.de/saqc/gettingstarted/TutorialAPI.html)
 of the documentation.
 
 ## Changelog

sphinxdoc/documentation/GenericFunctions.rst

@@ -35,7 +35,7 @@ signature looks like that:
 
 where ``<expression>`` is composed of the `supported constructs`_
 and ``<flag_constant>`` is one of the predefined
-:ref:`flagging constants <getting_started/ParameterDescriptions:flagging constants>` (default: ``BAD``\ ).
+:ref:`flagging constants <gettingstarted/ParameterDescriptions:flagging constants>` (default: ``BAD``\ ).
 Generic flagging functions are expected to return a boolean value, i.e. ``True`` or ``False``. All other expressions will
 fail during the runtime of ``SaQC``.
 
@@ -322,4 +322,4 @@ Constants
 ^^^^^^^^^
 
 Generic functions support the same constants as normal functions, a detailed 
-list is available :ref:`here <getting_started/ParameterDescriptions:constants>`.
+list is available :ref:`here <gettingstarted/ParameterDescriptions:constants>`.

sphinxdoc/getting_started/ConfigurationFiles.rst → sphinxdoc/gettingstarted/ConfigurationFiles.rst

@@ -32,7 +32,7 @@ configuration headers have a look `here <saqc/core/config.py>`_.
      - name of a variable
      - yes
    * - test
-     - :ref:`function notation <getting_started/ConfigurationFiles:test function notation>`
+     - :ref:`function notation <gettingstarted/ConfigurationFiles:test function notation>`
      - test function
      - yes
    * - plot

sphinxdoc/getting_started/Customizations.rst → sphinxdoc/gettingstarted/Customizations.rst

@@ -13,8 +13,8 @@ functions provided won't fulfill all your needs and requirements.
 
 Acknowledging the impossibility to address all imaginable use cases, we 
 designed the system to allow for extensions and costumizations. The main extensions options, namely 
-:ref:`quality check routines <getting_started/Customizations:custom quality check routines>`
-and the :ref:`flagging scheme <getting_started/Customizations:custom flagging schemes>`
+:ref:`quality check routines <gettingstarted/Customizations:custom quality check routines>`
+and the :ref:`flagging scheme <gettingstarted/Customizations:custom flagging schemes>`
 are described within this documents.
 
 Custom quality check routines
@@ -28,7 +28,7 @@ SaQC provides two ways to integrate custom routines into the system:
 
 
 #. The :ref:`extension language <documentation/GenericFunctions:Generic Functions>`
-#. An :ref:`interface <getting_started/Customizations:interface>` to the evaluation machinery
+#. An :ref:`interface <gettingstarted/Customizations:interface>` to the evaluation machinery
 
 Interface
 ^^^^^^^^^

sphinxdoc/getting_started/TutorialAPI.rst → sphinxdoc/gettingstarted/TutorialAPI.rst

@@ -178,7 +178,7 @@ Can I get something visual, please?
 -----------------------------------
 
 We provide an elaborated plotting method to generate and show or write matplotlib figures. Building on
-the example :ref:`above <getting_started/TutorialAPI:putting it together - the complete workflow>` above
+the example :ref:`above <gettingstarted/TutorialAPI:putting it together - the complete workflow>` above
 simply call:
 
 .. testcode:: python

sphinxdoc/index.rst

@@ -19,9 +19,9 @@ Getting Started
    :maxdepth: 1
    :hidden:
 
-   getting_started/InstallationGuide
-   getting_started/TutorialAPI
-   getting_started/TutorialCLI
+   gettingstarted/InstallationGuide
+   gettingstarted/TutorialAPI
+   gettingstarted/TutorialCLI
 
 
 .. toctree::

sphinxdoc/misc/title.rst

@@ -66,8 +66,8 @@ Features
 .. list-table::
 
     * - |pyLogo| |csvConfig|
-      - * :ref:`get and install SaQC <getting_started/InstallationGuide:installation guide>`
-        * :ref:`use the SaQC python API, enabling integration into larger programs <getting_started/TutorialAPI:python api>`
+      - * :ref:`get and install SaQC <gettingstarted/InstallationGuide:installation guide>`
+        * :ref:`use the SaQC python API, enabling integration into larger programs <gettingstarted/TutorialAPI:python api>`
         * or use SaQC as a commandline application and configure your pipelines via plain text
     * - |sacRaw|
       - * easily load data from multiple sources, concatenating them in a SaQC object