diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..47dbcbf --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +sklarpy +======= + +.. toctree:: + :maxdepth: 4 + + sklarpy diff --git a/docs/source/sklarpy.copulas.rst b/docs/source/sklarpy.copulas.rst new file mode 100644 index 0000000..883d79e --- /dev/null +++ b/docs/source/sklarpy.copulas.rst @@ -0,0 +1,37 @@ +sklarpy.copulas package +======================= + +Submodules +---------- + +sklarpy.copulas.distributions module +------------------------------------ + +.. automodule:: sklarpy.copulas.distributions + :members: + :undoc-members: + :show-inheritance: + +sklarpy.copulas.distributions\_map module +----------------------------------------- + +.. automodule:: sklarpy.copulas.distributions_map + :members: + :undoc-members: + :show-inheritance: + +sklarpy.copulas.marginal\_fitter module +--------------------------------------- + +.. automodule:: sklarpy.copulas.marginal_fitter + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sklarpy.copulas + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.misc.rst b/docs/source/sklarpy.misc.rst new file mode 100644 index 0000000..66de11e --- /dev/null +++ b/docs/source/sklarpy.misc.rst @@ -0,0 +1,45 @@ +sklarpy.misc package +==================== + +Submodules +---------- + +sklarpy.misc.correlation module +------------------------------- + +.. automodule:: sklarpy.misc.correlation + :members: + :undoc-members: + :show-inheritance: + +sklarpy.misc.debye module +------------------------- + +.. automodule:: sklarpy.misc.debye + :members: + :undoc-members: + :show-inheritance: + +sklarpy.misc.gradient module +---------------------------- + +.. automodule:: sklarpy.misc.gradient + :members: + :undoc-members: + :show-inheritance: + +sklarpy.misc.modified\_bessel module +------------------------------------ + +.. automodule:: sklarpy.misc.modified_bessel + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sklarpy.misc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.multivariate.rst b/docs/source/sklarpy.multivariate.rst new file mode 100644 index 0000000..ec7aa4c --- /dev/null +++ b/docs/source/sklarpy.multivariate.rst @@ -0,0 +1,29 @@ +sklarpy.multivariate package +============================ + +Submodules +---------- + +sklarpy.multivariate.distributions module +----------------------------------------- + +.. automodule:: sklarpy.multivariate.distributions + :members: + :undoc-members: + :show-inheritance: + +sklarpy.multivariate.distributions\_map module +---------------------------------------------- + +.. automodule:: sklarpy.multivariate.distributions_map + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sklarpy.multivariate + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.plotting.rst b/docs/source/sklarpy.plotting.rst new file mode 100644 index 0000000..7f3fcb8 --- /dev/null +++ b/docs/source/sklarpy.plotting.rst @@ -0,0 +1,10 @@ +sklarpy.plotting package +======================== + +Module contents +--------------- + +.. automodule:: sklarpy.plotting + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.rst b/docs/source/sklarpy.rst new file mode 100644 index 0000000..18bf876 --- /dev/null +++ b/docs/source/sklarpy.rst @@ -0,0 +1,24 @@ +sklarpy package +=============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + sklarpy.copulas + sklarpy.misc + sklarpy.multivariate + sklarpy.plotting + sklarpy.tests + sklarpy.univariate + sklarpy.utils + +Module contents +--------------- + +.. automodule:: sklarpy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.tests.copulas.rst b/docs/source/sklarpy.tests.copulas.rst new file mode 100644 index 0000000..511c2a9 --- /dev/null +++ b/docs/source/sklarpy.tests.copulas.rst @@ -0,0 +1,53 @@ +sklarpy.tests.copulas package +============================= + +Submodules +---------- + +sklarpy.tests.copulas.conftest module +------------------------------------- + +.. automodule:: sklarpy.tests.copulas.conftest + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.copulas.helpers module +------------------------------------ + +.. automodule:: sklarpy.tests.copulas.helpers + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.copulas.test\_fitted\_dists module +------------------------------------------------ + +.. automodule:: sklarpy.tests.copulas.test_fitted_dists + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.copulas.test\_marginal\_fitter module +--------------------------------------------------- + +.. automodule:: sklarpy.tests.copulas.test_marginal_fitter + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.copulas.test\_prefit\_dists module +------------------------------------------------ + +.. automodule:: sklarpy.tests.copulas.test_prefit_dists + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sklarpy.tests.copulas + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.tests.misc.rst b/docs/source/sklarpy.tests.misc.rst new file mode 100644 index 0000000..8ef28b5 --- /dev/null +++ b/docs/source/sklarpy.tests.misc.rst @@ -0,0 +1,61 @@ +sklarpy.tests.misc package +========================== + +Submodules +---------- + +sklarpy.tests.misc.conftest module +---------------------------------- + +.. automodule:: sklarpy.tests.misc.conftest + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.misc.helpers module +--------------------------------- + +.. automodule:: sklarpy.tests.misc.helpers + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.misc.test\_correlation module +------------------------------------------- + +.. automodule:: sklarpy.tests.misc.test_correlation + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.misc.test\_debye module +------------------------------------- + +.. automodule:: sklarpy.tests.misc.test_debye + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.misc.test\_gradient module +---------------------------------------- + +.. automodule:: sklarpy.tests.misc.test_gradient + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.misc.test\_modified\_bessel module +------------------------------------------------ + +.. automodule:: sklarpy.tests.misc.test_modified_bessel + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sklarpy.tests.misc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.tests.multivariate.rst b/docs/source/sklarpy.tests.multivariate.rst new file mode 100644 index 0000000..d4d567a --- /dev/null +++ b/docs/source/sklarpy.tests.multivariate.rst @@ -0,0 +1,45 @@ +sklarpy.tests.multivariate package +================================== + +Submodules +---------- + +sklarpy.tests.multivariate.conftest module +------------------------------------------ + +.. automodule:: sklarpy.tests.multivariate.conftest + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.multivariate.helpers module +----------------------------------------- + +.. automodule:: sklarpy.tests.multivariate.helpers + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.multivariate.test\_fitted\_dists module +----------------------------------------------------- + +.. automodule:: sklarpy.tests.multivariate.test_fitted_dists + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.multivariate.test\_prefit\_dists module +----------------------------------------------------- + +.. automodule:: sklarpy.tests.multivariate.test_prefit_dists + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sklarpy.tests.multivariate + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.tests.rst b/docs/source/sklarpy.tests.rst new file mode 100644 index 0000000..763d30d --- /dev/null +++ b/docs/source/sklarpy.tests.rst @@ -0,0 +1,22 @@ +sklarpy.tests package +===================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + sklarpy.tests.copulas + sklarpy.tests.misc + sklarpy.tests.multivariate + sklarpy.tests.univariate + sklarpy.tests.utils + +Module contents +--------------- + +.. automodule:: sklarpy.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.tests.univariate.rst b/docs/source/sklarpy.tests.univariate.rst new file mode 100644 index 0000000..4ce2a47 --- /dev/null +++ b/docs/source/sklarpy.tests.univariate.rst @@ -0,0 +1,53 @@ +sklarpy.tests.univariate package +================================ + +Submodules +---------- + +sklarpy.tests.univariate.conftest module +---------------------------------------- + +.. automodule:: sklarpy.tests.univariate.conftest + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.univariate.helpers module +--------------------------------------- + +.. automodule:: sklarpy.tests.univariate.helpers + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.univariate.test\_fitted\_dists module +--------------------------------------------------- + +.. automodule:: sklarpy.tests.univariate.test_fitted_dists + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.univariate.test\_prefit\_dists module +--------------------------------------------------- + +.. automodule:: sklarpy.tests.univariate.test_prefit_dists + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.univariate.test\_univariate\_fitter module +-------------------------------------------------------- + +.. automodule:: sklarpy.tests.univariate.test_univariate_fitter + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sklarpy.tests.univariate + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.tests.utils.rst b/docs/source/sklarpy.tests.utils.rst new file mode 100644 index 0000000..1ba92ff --- /dev/null +++ b/docs/source/sklarpy.tests.utils.rst @@ -0,0 +1,37 @@ +sklarpy.tests.utils package +=========================== + +Submodules +---------- + +sklarpy.tests.utils.conftest module +----------------------------------- + +.. automodule:: sklarpy.tests.utils.conftest + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.utils.test\_object\_printing module +------------------------------------------------- + +.. automodule:: sklarpy.tests.utils.test_object_printing + :members: + :undoc-members: + :show-inheritance: + +sklarpy.tests.utils.test\_serialize module +------------------------------------------ + +.. automodule:: sklarpy.tests.utils.test_serialize + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sklarpy.tests.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.univariate.rst b/docs/source/sklarpy.univariate.rst new file mode 100644 index 0000000..9a329bf --- /dev/null +++ b/docs/source/sklarpy.univariate.rst @@ -0,0 +1,37 @@ +sklarpy.univariate package +========================== + +Submodules +---------- + +sklarpy.univariate.distributions module +--------------------------------------- + +.. automodule:: sklarpy.univariate.distributions + :members: + :undoc-members: + :show-inheritance: + +sklarpy.univariate.distributions\_map module +-------------------------------------------- + +.. automodule:: sklarpy.univariate.distributions_map + :members: + :undoc-members: + :show-inheritance: + +sklarpy.univariate.univariate\_fitter module +-------------------------------------------- + +.. automodule:: sklarpy.univariate.univariate_fitter + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: sklarpy.univariate + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sklarpy.utils.rst b/docs/source/sklarpy.utils.rst new file mode 100644 index 0000000..d960850 --- /dev/null +++ b/docs/source/sklarpy.utils.rst @@ -0,0 +1,10 @@ +sklarpy.utils package +===================== + +Module contents +--------------- + +.. automodule:: sklarpy.utils + :members: + :undoc-members: + :show-inheritance: