adding to docs

tfm000 · Nov 28, 2023 · c1807e8 · c1807e8
1 parent d577b84
commit c1807e8
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,9 @@
     <a href="https://github.com/tfm000/sklarpy/actions/workflows/tests.yml">
         <img src="https://github.com/tfm000/sklarpy/actions/workflows/tests.yml/badge.svg?branch=main"
             alt="build"></a> &nbsp;
+    <a href="https://sklarpy.readthedocs.io/en/latest/?badge=latest">
+        <img src="https://readthedocs.org/projects/sklarpy/badge/?version=latest"
+            alt="build"></a> &nbsp;
     <a href="https://pepy.tech/project/sklarpy">
         <img src="https://static.pepy.tech/personalized-badge/sklarpy?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads"
             alt="downloads"></a> &nbsp;

diff --git a/docs/source/Univariate.rst b/docs/source/Univariate.rst
@@ -4,3 +4,27 @@
 Univariate Distributions
 #########################
 
+This SklarPy package contains many different univariate distributions in addition to objects allowing for easy fitting.
+With the exception of a handful of distributions, all univariate distribution objects are wrappers of scipy.stats univariate distributions, with added functionalities for plotting, fitting and saving.
+
+There is also the UnivariateFitter object, which allows for easy fitting of univariate distributions to data and for determining the best / statistically significant distribution(s).
+
+.. automodule:: sklarpy.univariate
+    :members:
+    :exclude-members: UnivariateFitter
+
+    .. autoclass:: UnivariateFitter
+        :members:
+
+    .. automethod:: __init__
+
+    .. automethod:: fit
+
+    .. caution::
+
+        If 'use_processpoolexecutor' is set to True, the UnivariateFitter object will use the ProcessPoolExecutor to parallelize the fitting process. However, if the code is ran outside 'if __name__ == "__main__":', you may receive a runtime error.
+
+    .. automethod:: plot
+
+    .. automethod:: fitted_distributions
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -17,6 +17,9 @@
             <a href="https://github.com/tfm000/sklarpy/actions/workflows/tests.yml">
                 <img src="https://github.com/tfm000/sklarpy/actions/workflows/tests.yml/badge.svg"
                     alt="build"></a> &nbsp;
+            <a href="https://sklarpy.readthedocs.io/en/latest/?badge=latest">
+                <img src="https://readthedocs.org/projects/sklarpy/badge/?version=latest"
+                    alt="build"></a> &nbsp;
             <a href="https://pepy.tech/project/sklarpy">
                 <img src="https://static.pepy.tech/personalized-badge/sklarpy?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads"
                     alt="downloads"></a> &nbsp;