Fix missing function documentation (#85)

.github/workflows/_build_doc.yaml

@@ -34,6 +34,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          python -m pip install .
           python -m pip install -r doc/requirements.txt
 
       - name: Build the documentation

doc/conf.py

@@ -10,15 +10,16 @@
 
 """This module is the configuration for the Sphinx documentation building process"""
 
-import os
 import sys
+from pathlib import Path
 
 project = "python-cmethods"
 copyright = "2023, Benjamin Thomas Schwertfeger"  # pylint: disable=redefined-builtin
 author = "Benjamin Thomas Schwertfeger"
 
 # to import the package
-sys.path.insert(0, os.path.abspath(".."))
+parent_directory = Path("..").resolve()
+sys.path.insert(0, str(parent_directory))
 
 # import links
 rst_epilog = ""
@@ -50,6 +51,5 @@
     "display_github": True,
     "github_user": "btschwertfeger",
     "github_repo": "python-cmethods",
-    "github_version": "master/docs/",
+    "github_version": "master/doc/",
 }
-# html_theme_options = {

doc/license.rst

@@ -8,4 +8,4 @@
 License
 =======
 
-.. include:: ../../LICENSE
+.. include:: ../LICENSE

doc/methods.rst

@@ -6,9 +6,20 @@
 Bias Correction Methods
 =======================
 
-Please note that the formulas are meant to be applied to a single time series.
-The python-cmethods package can apply these formulas to single and
-multidimensional data.
+General
+-------
+
+- Please note that the formulas are meant to be applied to a single time series.
+  The python-cmethods package can apply these formulas to single and
+  multidimensional data.
+- Selecting the appropriate number of quantiles for distribution-based
+  techniques is a challenging task. The number of quantiles determines the
+  number of bins of the probability density function and the cumulative
+  distribution function, which represent the distribution of the time series.
+  The number of quantiles should be large enough to capture the nuances of the
+  distribution functions but not excessively high, as this can result in a
+  straight-line distribution, which lead to artificial bias while interpolating.
+
 
 .. _linear-scaling:
 

doc/requirements.txt

@@ -1,7 +1,7 @@
+cloup
 netCDF4>=1.6.1
 numpy
 setuptools_scm
 sphinx
 sphinx-rtd-theme
-tqdm
 xarray>=2022.11.0