From 544fdb78494fac6b537eeeb9a68db52759352c33 Mon Sep 17 00:00:00 2001
From: Tyler <tylerfmitchell@gmail.com>
Date: Tue, 28 Nov 2023 20:53:33 +0000
Subject: [PATCH] adding to docs

---
 README.md                  |  2 ++
 docs/source/Univariate.rst | 12 ++++++++++--
 docs/source/conf.py        |  2 +-
 3 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 2cbc243..29812cd 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,8 @@ Named after Sklar's theorem and Abe Sklar, the American mathematician who proved
 
 This library has many different possible use cases, ranging from machine learning to finance.
 
+## Read the Docs
+Official SklarPy documentation can be found <a href="https://sklarpy.readthedocs.io/en/latest/"> here</a>.
 
 ## Table of contents
 
diff --git a/docs/source/Univariate.rst b/docs/source/Univariate.rst
index b3f8c09..9bba1ac 100644
--- a/docs/source/Univariate.rst
+++ b/docs/source/Univariate.rst
@@ -17,7 +17,7 @@ If you try::
 
     from sklarpy.univariate import normal
 
-You will likely find that your interpreter flags an error along the lines of "cannot find reference 'normal' in __init__.py"
+You will likely find that your interpreter flags an error along the lines of "cannot find reference 'normal' in __init__.py".
 Do not worry, this is to be expected an a side effect of the dynamic way SklarPy univariate distributions are created from scipy.stats distributions.
 At runtime, *your code will work without any errors*!
 
@@ -36,7 +36,7 @@ For scipy version 1.11.4 you should get an output along the lines of:
 
 So you have a lot to choose from!
 
-.. automodule:: sklarpy.univariate
+.. automodule:: sklarpy.univariate.univariate_fitter
     :members:
     :exclude-members: UnivariateFitter
 
@@ -51,7 +51,15 @@ So you have a lot to choose from!
 
         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:: get_summary
+
+    .. automethod:: get_best
+
     .. automethod:: plot
 
     .. automethod:: fitted_distributions
 
+
+.. automodule:: sklarpy.univariate._prefit
+    :members:
+    :exclude-members: PreFitUnivariateBase, PreFitNumericalUnivariateBase
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 750fb68..4ab9d24 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -2,7 +2,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("..."))
 
 # -- Project information