Docs restructuring

docs/documentation/documentationPanels.rst

@@ -18,7 +18,7 @@ Documentation
    SourceTarget
    FlaggingTranslation
 
-.. grid:: 3
+.. grid:: 2
    :gutter: 2
 
    .. grid-item-card:: Configuration files (csv)
@@ -41,5 +41,12 @@ Documentation
       +++
       *Keywords shared by all the flagging functions*
 
+   .. grid-item-card:: Customizations
+      :link: Customizations
+      :link-type: doc
+
+      * add custom functions to SaQC
+      +++
+      *Keywords shared by all the flagging functions*
 
 

docs/funcs/basicAnomalies.rst

@@ -3,7 +3,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
 Basic Anomalies
-===============
+---------------
 
 .. currentmodule:: saqc
 

docs/funcs/dataProducts.rst

@@ -3,8 +3,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
 Data Products
-=============
-
+-------------
 
 .. currentmodule:: saqc
 

docs/funcs/distributionalAnomalies.rst

@@ -3,7 +3,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
 Change Points and Noise
-=======================
+-----------------------
 
 
 .. currentmodule:: saqc

docs/funcs/driftBehavior.rst

@@ -3,7 +3,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
 Drift detection and correction
-==============================
+------------------------------
 
 .. currentmodule:: saqc
 

docs/funcs/filling.rst

@@ -3,9 +3,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
 Gap filling
-===========
-
-
+-----------
 
 .. currentmodule:: saqc
 

docs/funcs/flagTools.rst

@@ -2,8 +2,8 @@
 ..
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
-flagtools
-=========
+Flagtools
+---------
 
 .. currentmodule:: saqc
 

docs/funcs/funcsPanels.rst

@@ -5,126 +5,131 @@
 .. _funcs:
 
 
-Anomaly Detection
-------------------
+Functionality Overview
+----------------------
+..
+   Anomaly Detection
+   ------------------
 
-.. grid:: 2
+.. grid:: 1
    :gutter: 2
 
-   .. grid-item-card:: Basic Anomaly Detection
-      :link: basicAnomalies
-      :link-type: doc
+   .. grid-item-card:: Anomaly Detection
 
-      * data *gaps*,
-      * data *jumps*,
-      * *isolated* points,
-      * *constant* and low variance regimes.
-      +++
+      .. grid:: 2
+         :gutter: 2
 
-   .. grid-item-card:: Outlier Detection
-      :link: outlierDetection
-      :link-type: doc
+         .. grid-item-card:: Basic Anomaly Detection
+            :link: basicAnomalies
+            :link-type: doc
 
-      * rolling *Z-score* cutoff
-      * modified local outlier factor (univariate-*LOF*)
-      * deterministic *offset pattern* search
-      +++
+            * data *gaps*,
+            * data *jumps*,
+            * *isolated* points,
+            * *constant* and low variance regimes.
+            +++
 
-   .. grid-item-card:: Multivariate Analysis
-      :link: multivariateAnalysis
-      :link-type: doc
+         .. grid-item-card:: Outlier Detection
+            :link: outlierDetection
+            :link-type: doc
 
-      * k-nearest neighbor scores (*kNN*)
-      * local outlier factor (*LOF*)
-      +++
+            * rolling *Z-score* cutoff
+            * modified local outlier factor (univariate-*LOF*)
+            * deterministic *offset pattern* search
+            +++
 
-   .. grid-item-card:: Distributional Analysis
-      :link: distributionalAnomalies
-      :link-type: doc
+         .. grid-item-card:: Multivariate Analysis
+            :link: multivariateAnalysis
+            :link-type: doc
 
-      * detect *change points*
-      * detect continuous *noisy* data sections
-      +++
+            * k-nearest neighbor scores (*kNN*)
+            * local outlier factor (*LOF*)
+            +++
 
-Data and Flags Tools
---------------------
+         .. grid-item-card:: Distributional Analysis
+            :link: distributionalAnomalies
+            :link-type: doc
 
-.. grid:: 2
-   :gutter: 2
+            * detect *change points*
+            * detect continuous *noisy* data sections
+            +++
 
-   .. grid-item-card:: Data Independent Flags Manipulation
-      :link: flagTools
-      :link-type: doc
 
-      * *copy* flags
-      * *transfer* flags
-      * *propagate* flags
-      * *force*-set unitary or precalculated flags values
-      +++
+   .. grid-item-card:: Data and Flag Tools
 
-   .. grid-item-card:: Basic tools
-      :link: tools
-      :link-type: doc
+      .. grid:: 2
+         :gutter: 2
 
-      * plot variables
-      * copy and delete variables
-      +++
+         .. grid-item-card:: Data Independent Flags Manipulation
+            :link: flagTools
+            :link-type: doc
 
-   .. grid-item-card:: Generic and Custom Functions
-      :link: genericWrapper
-      :link-type: doc
+            * *copy* flags
+            * *transfer* flags
+            * *propagate* flags
+            * *force*-set unitary or precalculated flags values
+            +++
 
-      * basic *logical* aggregation of variables
-      * basic *arithmetical* aggregation of variables
-      * *custom functions*
-      * *rolling*, *resampling*, *transformation*
-      +++
+         .. grid-item-card:: Basic tools
+            :link: tools
+            :link-type: doc
 
+            * plot variables
+            * copy and delete variables
+            +++
 
-Data Manipulation
------------------
+         .. grid-item-card:: Generic and Custom Functions
+            :link: genericWrapper
+            :link-type: doc
 
-.. grid:: 2
-   :gutter: 2
+            * basic *logical* aggregation of variables
+            * basic *arithmetical* aggregation of variables
+            * *custom functions*
+            * *rolling*, *resampling*, *transformation*
+            +++
 
-   .. grid-item-card:: Data Products
-      :link: dataProducts
-      :link-type: doc
+   .. grid-item-card:: Data Manipulation
 
-      * smooth with *frequency filter*
-      * smooth with *polynomials*
-      * obtain *residuals* from smoothing
-      * obtain *kNN* or *LOF* scores
-      +++
+      .. grid:: 2
+         :gutter: 2
 
-   .. grid-item-card:: Resampling
-      :link: samplingAlignment
-      :link-type: doc
+         .. grid-item-card:: Data Products
+            :link: dataProducts
+            :link-type: doc
 
-      * *resample* data using custom aggregation
-      * *align* data to frequency grid with minimal data distortion
-      * *back project* flags from aligned data onto original series
-      +++
+            * smooth with *frequency filter*
+            * smooth with *polynomials*
+            * obtain *residuals* from smoothing
+            * obtain *kNN* or *LOF* scores
+            +++
 
-Data Correction
----------------
+         .. grid-item-card:: Resampling
+            :link: samplingAlignment
+            :link-type: doc
 
-.. grid:: 2
-   :gutter: 2
+            * *resample* data using custom aggregation
+            * *align* data to frequency grid with minimal data distortion
+            * *back project* flags from aligned data onto original series
+            +++
+
+   .. grid-item-card:: Data Correction
+
+      .. grid:: 2
+         :gutter: 2
 
-   .. grid-item-card:: Gap filling
-      :link: filling
-      :link-type: doc
+         .. grid-item-card:: Gap filling
+            :link: filling
+            :link-type: doc
 
-      * fill gaps with *interpolations*
-      * fill gaps using a *rolling* window
-      +++
+            * fill gaps with *interpolations*
+            * fill gaps using a *rolling* window
+            +++
 
-   .. grid-item-card:: Drift Detection and Correction
-      :link: driftBehavior
-      :link-type: doc
+         .. grid-item-card:: Drift Detection and Correction
+            :link: driftBehavior
+            :link-type: doc
 
-      * deviation predicted by a *model*
-      * deviation from the *majority* of parallel curves
-      * deviation from a defined *norm* curve
-      +++
+            * deviation predicted by a *model*
+            * deviation from the *majority* of parallel curves
+            * deviation from a defined *norm* curve
+            +++

docs/funcs/genericWrapper.rst

@@ -2,8 +2,8 @@
 ..
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
-generic wrapper
-===============
+Generic Functions
+-----------------
 
 
 .. currentmodule:: saqc

docs/funcs/multivariateAnalysis.rst

@@ -3,7 +3,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
 Multivariate Analysis
-=====================
+---------------------
 
 Multivariate outlier detection.
 

docs/funcs/outlierDetection.rst

@@ -3,7 +3,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
 Outlier Detection
-=================
+-----------------
 
 Univariate Outlier Detection
 

docs/funcs/samplingAlignment.rst

@@ -3,7 +3,7 @@
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
 Sampling Alignment
-==================
+------------------
 
 .. currentmodule:: saqc
 

docs/funcs/tools.rst

@@ -2,9 +2,8 @@
 ..
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
-tools
-=====
-
+Tools
+-----
 
 .. currentmodule:: saqc
 

docs/index.rst

@@ -20,14 +20,11 @@
 
 
 .. toctree::
-   :caption: SaQC
    :hidden:
    :maxdepth: 1
 
    Package <modules/SaQC>
-   Core <modules/SaQCCore>
    Test Functions <modules/SaQCFunctions>
-   Translations <modules/SaQCTranslation>
    Constants <modules/SaQCConstants>
 
 

docs/misc/title.rst

@@ -69,13 +69,13 @@ Documentation
       *Step-by-step guides to the implementation of basic QC tasks in SaQC*
 
 
-   .. grid-item-card:: Documentations
+   .. grid-item-card:: Documentation
       :link: ../documentation/documentationPanels
       :link-type: doc
 
       * CSV file-controlled flagging
-      * flagging schemes
-      * managing sources and targets Of algorithm application
+      * global keywords
+      * customization
       +++
       *Introductions to core mechanics and principles*
 

docs/modules/SaQCCore.rst

-.. SPDX-FileCopyrightText: 2021 Helmholtz-Zentrum für Umweltforschung GmbH - UFZ
-..
-.. SPDX-License-Identifier: GPL-3.0-or-later
-
-SaQC
-====
-
-.. automodapi:: saqc.core
-   :include-all-objects:
-
-

docs/modules/SaQCFunctions.rst

@@ -2,14 +2,21 @@
 ..
 .. SPDX-License-Identifier: GPL-3.0-or-later
 
-SaQC
-====
-
 Test Functions
---------------
+==============
 
 .. toctree::
-   :glob:
-
-   ../funcs/*
+   :maxdepth: 1
+   :hidden:
 
+.. include:: ../funcs/basicAnomalies.rst
+.. include:: ../funcs/distributionalAnomalies.rst
+.. include:: ../funcs/filling.rst
+.. include:: ../funcs/multivariateAnalysis.rst
+.. include:: ../funcs/samplingAlignment.rst
+.. include:: ../funcs/dataProducts.rst
+.. include:: ../funcs/driftBehavior.rst
+.. include:: ../funcs/flagTools.rst
+.. include:: ../funcs/genericWrapper.rst
+.. include:: ../funcs/outlierDetection.rst
+.. include:: ../funcs/tools.rst

docs/modules/SaQCTranslation.rst

-.. SPDX-FileCopyrightText: 2021 Helmholtz-Zentrum für Umweltforschung GmbH - UFZ
-..
-.. SPDX-License-Identifier: GPL-3.0-or-later
-
-SaQC
-====
-
-.. automodapi:: saqc.core.translation
-   :include-all-objects: