Improve docs.

vnmabus · Dec 24, 2022 · 8e063d2 · 8e063d2
1 parent 91cc067
commit 8e063d2
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 6 deletions.
diff --git a/dcor/__init__.py b/dcor/__init__.py
@@ -13,6 +13,7 @@
 from . import distances, homogeneity, independence
 from ._dcor import (
     DistanceCovarianceMethod as DistanceCovarianceMethod,
+    Stats as Stats,
     distance_correlation as distance_correlation,
     distance_correlation_af_inv as distance_correlation_af_inv,
     distance_correlation_af_inv_sqr as distance_correlation_af_inv_sqr,
@@ -37,6 +38,7 @@
     EstimationStatistic as EstimationStatistic,
     energy_distance as energy_distance,
 )
+from ._hypothesis import HypothesisTest as HypothesisTest
 from ._partial_dcor import (
     partial_distance_correlation,
     partial_distance_covariance as partial_distance_covariance,

diff --git a/docs/apilist.rst b/docs/apilist.rst
@@ -128,14 +128,12 @@ List of classes
 ---------------
 A complete list of all classes provided by dcor.
 
-Methods for computing distance covariance
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The following enum lists the methods that can be used for computing distance
-covariance.
-
 .. autosummary::
    :toctree: functions
 
    dcor.CompileMode
    dcor.DistanceCovarianceMethod
-   dcor.EstimationStatistic
+   dcor.EstimationStatistic
+   dcor.HypothesisTest
+   dcor.RowwiseMode
+   dcor.Stats
diff --git a/docs/development.rst b/docs/development.rst
@@ -12,6 +12,13 @@ https://github.com/vnmabus/dcor/blob/develop/CONTRIBUTING.md.
 Building the documentation
 --------------------------
 
+In order to build the documentation, please first install the necessary
+packages listed in ``readthedocs-requirements.txt``:
+
+.. code-block:: bash
+
+	pip install -r readthedocs-requirements.txt
+
 The documentation and its configuration is stored in the ``docs`` subfolder.
 In order to build the documentation using Sphinx, execute the following
 commands in that folder: