readthedocs: fix generation of automatic documentation

Author: aldoglielmo

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-20.04
   tools:
-    python: "3.8"
+    python: "3.9"
     # You can also specify other tool versions:
     # nodejs: "16"
     # rust: "1.55"

dadapy/__init__.py

@@ -1,5 +1,6 @@
 from ._utils.utils import *
-from .clustering import *
-from .data import *
-from .density_estimation import *
-from .id_estimation import *
+from .base import Base
+from .clustering import Clustering
+from .data import Data
+from .density_estimation import DensityEstimation
+from .id_estimation import IdEstimation

docs/source/base.rst

@@ -1,5 +1,5 @@
 The base module
-==========================
+================================
 
-.. automodule:: dadapy.base
+.. automodule:: base
     :members:

docs/source/clustering.rst

@@ -1,5 +1,5 @@
 The clustering module
-==========================
+================================
 
 .. automodule:: clustering
     :members:

docs/source/conf.py

@@ -24,7 +24,7 @@
 sys.path.insert(0, os.path.abspath("../examples"))
 sys.path.insert(0, os.path.abspath("../../examples"))
 
-sys.path.insert(0, os.path.abspath("../../dadapy/_utils"))
+#sys.path.insert(0, os.path.abspath("../../dadapy/_utils"))
 
 # -- Project information -----------------------------------------------------
 
@@ -46,7 +46,8 @@
               "sphinx.ext.autodoc",
               "nbsphinx",
               "nbsphinx_link",
-              "sphinx.ext.napoleon"]
+              "sphinx.ext.napoleon",
+              "IPython.sphinxext.ipython_console_highlighting"]
 
 napoleon_custom_sections = [("Returns", "params_style")]
 

docs/source/data.rst

@@ -1,5 +1,5 @@
 The data module
-==========================
+================================
 
-.. automodule:: dadapy.data
+.. automodule:: data
     :members:

docs/source/density_estimation.rst

@@ -1,5 +1,5 @@
 The density_estimation module
-==============================
+================================
 
-.. automodule:: dadapy.density_estimation
+.. automodule:: density_estimation
     :members:

docs/source/id_estimation.rst

@@ -1,5 +1,5 @@
 The id_estimation module
-==========================
+================================
 
-.. automodule:: dadapy.id_estimation
+.. automodule:: id_estimation
     :members:

docs/source/metric_comparisons.rst

@@ -1,5 +1,6 @@
 The metric_comparisons module
-=============================
+================================
 
-.. automodule:: dadapy.metric_comparisons
-    :members:
+.. automodule:: metric_comparisons
+    :members:
+    :undoc-members:

docs/source/utils.rst

@@ -3,5 +3,5 @@ The utils module
 
 The *utils* module contains a variety of functions useful to the different classes of the package.
 
-.. automodule:: utils
+.. automodule:: _utils.utils
     :members: