added doc decorator to core.modules

saqc/core/modules/breaks.py

@@ -9,14 +9,17 @@ from __future__ import annotations
 
 from saqc.constants import BAD, FILTER_ALL
 import saqc
-
+from sphinxdoc.scripts.templates import doc
 
 class Breaks:
+
+    @doc(saqc.funcs.breaks.flagMissing.__doc__)
     def flagMissing(
         self, field: str, flag: float = BAD, dfilter: float = FILTER_ALL, **kwargs
     ) -> saqc.SaQC:
         return self._defer("flagMissing", locals())
 
+    @doc(saqc.funcs.breaks.flagIsolated.__doc__)
     def flagIsolated(
         self,
         field: str,
@@ -27,6 +30,7 @@ class Breaks:
     ) -> saqc.SaQC:
         return self._defer("flagIsolated", locals())
 
+    @doc(saqc.funcs.breaks.flagJumps.__doc__)
     def flagJumps(
         self,
         field: str,

saqc/core/modules/changepoints.py

@@ -14,9 +14,12 @@ from typing_extensions import Literal
 
 from saqc.constants import BAD
 import saqc
+from sphinxdoc.scripts.templates import doc
 
 
 class ChangePoints:
+
+    @doc(saqc.funcs.changepoints.flagChangePoints.__doc__)
     def flagChangePoints(
         self,
         field: str,
@@ -32,6 +35,7 @@ class ChangePoints:
     ) -> saqc.SaQC:
         return self._defer("flagChangePoints", locals())
 
+    @doc(saqc.funcs.changepoints.assignChangePointCluster.__doc__)
     def assignChangePointCluster(
         self,
         field: str,

saqc/core/modules/constants.py

@@ -9,9 +9,12 @@ from __future__ import annotations
 
 from saqc.constants import BAD
 import saqc
+from sphinxdoc.scripts.templates import doc
 
 
 class Constants:
+
+    @doc(saqc.funcs.constants.flagByVariance.__doc__)
     def flagByVariance(
         self,
         field: str,
@@ -24,6 +27,7 @@ class Constants:
     ) -> saqc.SaQC:
         return self._defer("flagByVariance", locals())
 
+    @doc(saqc.funcs.constants.flagConstants.__doc__)
     def flagConstants(
         self, field: str, thresh: float, window: str, flag: float = BAD, **kwargs
     ) -> saqc.SaQC:

saqc/core/modules/curvefit.py

@@ -13,9 +13,12 @@ from typing_extensions import Literal
 
 from saqc.constants import BAD
 import saqc
+from sphinxdoc.scripts.templates import doc
 
 
 class Curvefit:
+
+    @doc(saqc.funcs.curvefit.fitPolynomial.__doc__)
     def fitPolynomial(
         self,
         field: str,

saqc/core/modules/drift.py

@@ -17,9 +17,11 @@ from saqc.constants import BAD
 import saqc
 from saqc.funcs import LinkageString
 from saqc.lib.types import CurveFitter
-
+from sphinxdoc.scripts.templates import doc
 
 class Drift:
+
+    @doc(saqc.drift.flagDriftFromNorm.__doc__)
     def flagDriftFromNorm(
         self,
         field: Sequence[str],
@@ -36,6 +38,7 @@ class Drift:
     ) -> saqc.SaQC:
         return self._defer("flagDriftFromNorm", locals())
 
+    @doc(saqc.drift.flagDriftFromReference.__doc__)
     def flagDriftFromReference(
         self,
         field: Sequence[str],
@@ -51,6 +54,8 @@ class Drift:
     ) -> saqc.SaQC:
         return self._defer("flagDriftFromReference", locals())
 
+
+    @doc(saqc.drift.correctDrift.__doc__)
     def correctDrift(
         self,
         field: str,
@@ -61,6 +66,8 @@ class Drift:
     ) -> saqc.SaQC:
         return self._defer("correctDrift", locals())
 
+
+    @doc(saqc.drift.correctRegimeAnomaly.__doc__)
     def correctRegimeAnomaly(
         self,
         field: str,
@@ -72,6 +79,8 @@ class Drift:
     ) -> saqc.SaQC:
         return self._defer("correctRegimeAnomaly", locals())
 
+
+    @doc(saqc.drift.correctOffset.__doc__)
     def correctOffset(
         self,
         field: str,

saqc/core/modules/flagtools.py

@@ -16,21 +16,27 @@ from typing_extensions import Literal
 
 from saqc.constants import BAD
 import saqc
-
+from sphinxdoc.scripts.templates import doc
 
 class FlagTools:
+
+    @doc(saqc.flagtools.clearFlags.__doc__)
     def clearFlags(self, field: str, **kwargs) -> saqc.SaQC:
         return self._defer("clearFlags", locals())
 
+    @doc(saqc.flagtools.forceFlags.__doc__)
     def forceFlags(self, field: str, flag: float = BAD, **kwargs) -> saqc.SaQC:
         return self._defer("forceFlags", locals())
 
+    @doc(saqc.flagDummy.forceFlags.__doc__)
     def flagDummy(self, field: str, **kwargs) -> saqc.SaQC:
         return self._defer("flagDummy", locals())
 
+    @doc(saqc.flagtools.flagUnflagged.__doc__)
     def flagUnflagged(self, field: str, flag: float = BAD, **kwargs) -> saqc.SaQC:
         return self._defer("flagUnflagged", locals())
 
+    @doc(saqc.flagtools.flagManual.__doc__)
     def flagManual(
         self,
         field: str,
@@ -45,6 +51,7 @@ class FlagTools:
     ) -> saqc.SaQC:
         return self._defer("flagManual", locals())
 
+    @doc(saqc.flagtools.transferFlags.__doc__)
     def transferFlags(
         self,
         field: str | Sequence[str],

saqc/core/modules/generic.py

@@ -12,9 +12,11 @@ from typing import Sequence, Union
 import saqc
 from saqc.constants import UNFLAGGED, BAD, FILTER_ALL
 from saqc.lib.types import GenericFunction
-
+from sphinxdoc.scripts.templates import doc
 
 class Generic:
+
+    @doc(saqc.generic.processGeneric.__doc__)
     def processGeneric(
         self,
         field: str | Sequence[str],
@@ -26,6 +28,7 @@ class Generic:
     ) -> saqc.SaQC:
         return self._defer("processGeneric", locals())
 
+    @doc(saqc.generic.flagGeneric.__doc__)
     def flagGeneric(
         self,
         field: Union[str, Sequence[str]],

saqc/core/modules/interpolation.py

@@ -15,9 +15,11 @@ import pandas as pd
 from saqc.constants import UNFLAGGED
 import saqc
 from saqc.funcs.interpolation import _SUPPORTED_METHODS
-
+from sphinxdoc.scripts.templates import doc
 
 class Interpolation:
+
+    @doc(saqc.interpolation.interpolateByRolling.__doc__)
     def interpolateByRolling(
         self,
         field: str,
@@ -30,6 +32,8 @@ class Interpolation:
     ) -> saqc.SaQC:
         return self._defer("interpolateByRolling", locals())
 
+
+    @doc(saqc.interpolation.interpolateInvalid.__doc__)
     def interpolateInvalid(
         self,
         field: str,
@@ -42,6 +46,7 @@ class Interpolation:
     ) -> saqc.SaQC:
         return self._defer("interpolateInvalid", locals())
 
+    @doc(saqc.interpolation.interpolateIndex.__doc__)
     def interpolateIndex(
         self,
         field: str,

saqc/core/modules/noise.py

@@ -13,9 +13,11 @@ from typing import Callable
 
 from saqc.constants import BAD
 import saqc
-
+from sphinxdoc.scripts.templates import doc
 
 class Noise:
+
+    @doc(saqc.noise.flagByStatLowPass.__doc__)
     def flagByStatLowPass(
         self,
         field: str,

saqc/core/modules/outliers.py

@@ -15,9 +15,11 @@ from typing_extensions import Literal
 
 from saqc.constants import BAD
 import saqc
-
+from sphinxdoc.scripts.templates import doc
 
 class Outliers:
+
+    @doc(saqc.funcs.outliers.flagByStray.__doc__)
     def flagByStray(
         self,
         field: str,
@@ -30,6 +32,7 @@ class Outliers:
     ) -> saqc.SaQC:
         return self._defer("flagByStray", locals())
 
+    @doc(saqc.funcs.outliers.flagMVScores.__doc__)
     def flagMVScores(
         self,
         field: Sequence[str],
@@ -49,6 +52,7 @@ class Outliers:
     ) -> saqc.SaQC:
         return self._defer("flagMVScores", locals())
 
+    @doc(saqc.funcs.outliers.flagRaise.__doc__)
     def flagRaise(
         self,
         field: str,
@@ -64,6 +68,7 @@ class Outliers:
     ) -> saqc.SaQC:
         return self._defer("flagRaise", locals())
 
+    @doc(saqc.funcs.outliers.flagMAD.__doc__)
     def flagMAD(
         self,
         field: str,
@@ -74,6 +79,7 @@ class Outliers:
     ) -> saqc.SaQC:
         return self._defer("flagMAD", locals())
 
+    @doc(saqc.funcs.outliers.flagOffset.__doc__)
     def flagOffset(
         self,
         field: str,
@@ -86,6 +92,7 @@ class Outliers:
     ) -> saqc.SaQC:
         return self._defer("flagOffset", locals())
 
+    @doc(saqc.funcs.outliers.flagByGrubbs.__doc__)
     def flagByGrubbs(
         self,
         field: str,
@@ -98,6 +105,7 @@ class Outliers:
     ) -> saqc.SaQC:
         return self._defer("flagByGrubbs", locals())
 
+    @doc(saqc.funcs.outliers.flagRange.__doc__)
     def flagRange(
         self,
         field: str,
@@ -108,6 +116,7 @@ class Outliers:
     ) -> saqc.SaQC:
         return self._defer("flagRange", locals())
 
+    @doc(saqc.funcs.outliers.flagCrossStatistics.__doc__)
     def flagCrossStatistics(
         self,
         field: Sequence[str],

saqc/core/modules/pattern.py

@@ -9,9 +9,11 @@ from __future__ import annotations
 
 from saqc.constants import BAD
 import saqc
-
+from sphinxdoc.scripts.templates import doc
 
 class Pattern:
+
+    @doc(saqc.funcs.pattern.flagPatternByDTW.__doc__)
     def flagPatternByDTW(
         self,
         field,

saqc/core/modules/resampling.py

@@ -16,9 +16,11 @@ from typing_extensions import Literal
 from saqc.constants import BAD
 import saqc
 from saqc.funcs.interpolation import _SUPPORTED_METHODS
-
+from sphinxdoc.scripts.templates import doc
 
 class Resampling:
+
+    @doc(saqc.funcs.resampling.linear.__doc__)
     def linear(
         self,
         field: str,
@@ -27,6 +29,7 @@ class Resampling:
     ) -> saqc.SaQC:
         return self._defer("linear", locals())
 
+    @doc(saqc.funcs.resampling.interpolate.__doc__)
     def interpolate(
         self,
         field: str,
@@ -37,6 +40,7 @@ class Resampling:
     ) -> saqc.SaQC:
         return self._defer("interpolate", locals())
 
+    @doc(saqc.funcs.resampling.shift.__doc__)
     def shift(
         self,
         field: str,
@@ -47,6 +51,7 @@ class Resampling:
     ) -> saqc.SaQC:
         return self._defer("shift", locals())
 
+    @doc(saqc.funcs.resampling.resample.__doc__)
     def resample(
         self,
         field: str,
@@ -63,6 +68,8 @@ class Resampling:
     ) -> saqc.SaQC:
         return self._defer("resample", locals())
 
+
+    @doc(saqc.funcs.resampling.concatFlags.__doc__)
     def concatFlags(
         self,
         field: str,

saqc/core/modules/residues.py

@@ -15,9 +15,11 @@ from typing_extensions import Literal
 
 from saqc.constants import BAD
 import saqc
-
+from sphinxdoc.scripts.templates import doc
 
 class Residues:
+
+    @doc(saqc.funcs.residues.calculatePolynomialResidues.__doc__)
     def calculatePolynomialResidues(
         self,
         field: str,
@@ -28,6 +30,7 @@ class Residues:
     ) -> saqc.SaQC:
         return self._defer("calculatePolynomialResidues", locals())
 
+    @doc(saqc.funcs.residues.calculateRollingResidues.__doc__)
     def calculateRollingResidues(
         self,
         field: str,

saqc/core/modules/rolling.py

@@ -12,9 +12,11 @@ import numpy as np
 import pandas as pd
 
 from saqc.constants import BAD
-
+from sphinxdoc.scripts.templates import doc
 
 class Rolling:
+
+    @doc(saqc.funcs.rolling.roll.__doc__)
     def roll(
         self,
         field: str,

saqc/core/modules/scores.py

@@ -14,9 +14,11 @@ import pandas as pd
 from typing_extensions import Literal
 
 import saqc
-
+from sphinxdoc.scripts.templates import doc
 
 class Scores:
+
+    @doc(saqc.funcs.scores.assignKNNScore.__doc__)
     def assignKNNScore(
         self,
         field: Sequence[str],

saqc/core/modules/tools.py

@@ -14,20 +14,28 @@ import saqc
 import numpy as np
 
 from saqc.constants import FILTER_NONE
-
+from sphinxdoc.scripts.templates import doc
 
 class Tools:
+
+    @doc(saqc.funcs.tools.copyField.__doc__)
     def copyField(
         self, field: str, target: str, overwrite: bool = False, **kwargs
     ) -> saqc.SaQC:
         return self._defer("copyField", locals())
 
+
+    @doc(saqc.funcs.tools.dropField.__doc__)
     def dropField(self, field: str, **kwargs) -> saqc.SaQC:
         return self._defer("dropField", locals())
 
+
+    @doc(saqc.funcs.tools.renameField.__doc__)
     def renameField(self, field: str, new_name: str, **kwargs) -> saqc.SaQC:
         return self._defer("renameField", locals())
 
+
+    @doc(saqc.funcs.tools.maskTime.__doc__)
     def maskTime(
         self,
         field: str,
@@ -40,6 +48,8 @@ class Tools:
     ) -> saqc.SaQC:
         return self._defer("maskTime", locals())
 
+
+    @doc(saqc.funcs.tools.plot.__doc__)
     def plot(
         self,
         field: str,

saqc/core/modules/transformation.py

@@ -12,9 +12,11 @@ from typing import Callable, Optional, Union
 import pandas as pd
 
 import saqc
-
+from sphinxdoc.scripts.templates import doc
 
 class Transformation:
+
+    @doc(saqc.funcs.transformation.transform.__doc__)
     def transform(
         self,
         field: str,

sphinxdoc/Makefile

@@ -35,18 +35,18 @@ clean:
 # make doctest, make documentation, make clean
 doc:
 	# generate parent fake module for the functions to be documented
-	python scripts/make_doc_module.py -p "saqc/funcs" -sr ".." -su "funcSummaries"
+	#python scripts/make_doc_module.py -p "saqc/funcs" -sr ".." -su "funcSummaries"
 	# generate environment table from dictionary
 	python scripts/make_env_tab.py
 	@$(SPHINXBUILD) -M doctest "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-	python scripts/modify_html_API.py
+	#python scripts/modify_html_API.py
 	rm -f *.automodsumm
 	rm -f *.automodapi
 	rm -f moduleAPIs/*.automodsumm
 	rm -f moduleAPIs/*.automodapi
 	rm -f */*.automodsumm
-	rm -f -r coredoc
+	#rm -f -r coredoc
 
 # make documentation
 doconly:

sphinxdoc/environment/configEnv.rst

-.. SPDX-FileCopyrightText: 2021 Helmholtz-Zentrum für Umweltforschung GmbH - UFZ
-..
-.. SPDX-License-Identifier: GPL-3.0-or-later
-
 Config file Environment
 =======================
 

sphinxdoc/moduleAPIs/saqcFuncClass.rst

-.. SPDX-FileCopyrightText: 2021 Helmholtz-Zentrum für Umweltforschung GmbH - UFZ
-..
-.. SPDX-License-Identifier: GPL-3.0-or-later
-
-SaQC
-====
-
-.. automodapi:: sphinxdoc.coredoc
-
-
-