Merge branch 'cookBux' of https://git.ufz.de/rdm-software/saqc into cookBux

sphinx-doc/Makefile

@@ -28,6 +28,8 @@ clean:
 	rm -rf ../$(FUNCTIONS)
 	mkdir _static
 	# for k in $(MDLIST); do rm -r "$$k"_m2r; done
+	rm -f *.automodsumm
+	rm -f moduleAPIs/*.automodsumm
 
 # trigger (saqc) customized documentation pipeline
 doc:

sphinx-doc/cook_books/DataRegularisation.rst

-
 Data Regularisation
 ===================
 
@@ -9,27 +8,22 @@ spacing in between subsequent data points.
 The tutorial guides through the following steps: 
 
 
-#. 
-   Initially, we introduce and motivate regularisation techniques and we do import the tutorial data.
+#. Initially, we introduce and motivate regularisation techniques and we do import the tutorial data.
 
 
    * :ref:`Why Regularisation <cook_books/DataRegularisation:Why Regularisation>`
    * :ref:`Tutorial Data <cook_books/DataRegularisation:Tutorial Data>`
 
-#. 
-   We will get an overview over the main :ref:`Regularisation <cook_books/DataRegularisation:regularisations>` methods, starting with the shift.
-
+#. We will get an overview over the main :ref:`Regularisation <cook_books/DataRegularisation:regularisations>` methods, starting with the shift.
 
    * :ref:`Shift <cook_books/DataRegularisation:shift>`
+   * :ref:`Target Parameter <cook_books/DataRegularisation:target parameter>`
 
-     * :ref:`Target Parameter <cook_books/DataRegularisation:target parameter>`
-
-       * :ref:`Freq Parameter <cook_books/DataRegularisation:freq parameter>`
-       * :ref:`Method Parameter <cook_books/DataRegularisation:shifting method>`
-       * :ref:`Valid Data <cook_books/DataRegularisation:Valid Data>`
+      * :ref:`Freq Parameter <cook_books/DataRegularisation:freq parameter>`
+      * :ref:`Method Parameter <cook_books/DataRegularisation:shifting method>`
+      * :ref:`Valid Data <cook_books/DataRegularisation:Valid Data>`
 
-#. 
-   We introduce the notion of *valid* data and see how sparse intervals and those with multiple values interact with 
+#. We introduce the notion of *valid* data and see how sparse intervals and those with multiple values interact with
    regularisation.
 
 
@@ -41,8 +35,7 @@ The tutorial guides through the following steps:
        * :ref:`Data Reduction <cook_books/DataRegularisation:data reduction>`
        * :ref:`Minimize Shifting <cook_books/DataRegularisation:minimize shifting distance>`
 
-#. 
-   We use the Aggregation and the Interpolation method.
+#. We use the Aggregation and the Interpolation method.
 
 
    * :ref:`Aggregation <cook_books/DataRegularisation:aggregation>`
@@ -52,11 +45,9 @@ The tutorial guides through the following steps:
 
    * :ref:`Interpolation <cook_books/DataRegularisation:interpolation>`
 
-     * :ref:`Representing Data Sparsity <cook_books/DataRegularisation:interpolation and data sparsity>`
-
-#. 
-   We see how regularisation interacts with Flags.
+   * :ref:`Representing Data Sparsity <cook_books/DataRegularisation:interpolation and data sparsity>`
 
+#. We see how regularisation interacts with Flags.
 
    * :ref:`Flags and Regularisation <cook_books/DataRegularisation:flags and regularisation>`
 
@@ -78,7 +69,7 @@ way of constructing such a mapping, is to just resample all data at the same (re
 Tutorial Data
 -------------
 
-The following `dataset <../ressources/data/SoilMoisture.csv>`_ of Soil Moisture meassurements may serve as 
+The following `dataset <../ressources/data/SoilMoisture.csv>`_ of Soil Moisture measurements may serve as
 example data set:
 
 

sphinx-doc/index.rst

 
+
 .. include:: misc/title.rst
 
+
 .. toctree::
    :hidden:
    :maxdepth: 1
 
    Repository <https://git.ufz.de/rdm-software/saqc>
    Package API <moduleAPIs/saqcInit>
-
+   Doctesttest <misc/doctesttest>
 
 Getting Started
 ===============
@@ -52,9 +54,7 @@ Functions
    :titlesonly:
 
    All Functions <moduleAPIs/saqcFunctions>
-   generic <function_cats/generic>
-   resampling <function_cats/resampling>
-   tools <function_cats/tools>
+   generic <moduleAPIs/functionsgeneric>
 
 
 Python Package

sphinx-doc/misc/doctesttest.rst

+TestModuleDoc
+=============
+
+:Example:
+    >>> a=1
+    >>> a + 3
+    5
\ No newline at end of file

sphinx-doc/moduleAPIs/FunctionsBreaks.rst

-breaks
-======
-
-.. automodapi:: Functions.breaks
-	:no-heading:

sphinx-doc/moduleAPIs/FunctionsFlagtools.rst

-FlagTools
-=========
-
-.. automodapi:: Functions.flagtools
-	:no-heading:

sphinx-doc/moduleAPIs/FunctionsGeneric.rst

-Generic
-=======
-
-.. automodapi:: Functions.generic
-	:no-heading:

sphinx-doc/moduleAPIs/FunctionsSaqc.rst

-saqc
-====
-
-.. automodapi:: Functions.saqc
-   :no-heading:
-
-

sphinx-doc/moduleAPIs/FunctionsTools.rst

-Tools
-=====
-
-.. automodapi:: Functions.tools
-	:no-heading: