Skip to content

Commit

Permalink
adding sphinx auto doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tfm000 committed Dec 4, 2023
1 parent 8bf091a commit 7e93728
Show file tree
Hide file tree
Showing 14 changed files with 470 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
sklarpy
=======

.. toctree::
:maxdepth: 4

sklarpy
37 changes: 37 additions & 0 deletions docs/source/sklarpy.copulas.rst
Original file line number Diff line number Diff line change
@@ -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:
45 changes: 45 additions & 0 deletions docs/source/sklarpy.misc.rst
Original file line number Diff line number Diff line change
@@ -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:
29 changes: 29 additions & 0 deletions docs/source/sklarpy.multivariate.rst
Original file line number Diff line number Diff line change
@@ -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:
10 changes: 10 additions & 0 deletions docs/source/sklarpy.plotting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
sklarpy.plotting package
========================

Module contents
---------------

.. automodule:: sklarpy.plotting
:members:
:undoc-members:
:show-inheritance:
24 changes: 24 additions & 0 deletions docs/source/sklarpy.rst
Original file line number Diff line number Diff line change
@@ -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:
53 changes: 53 additions & 0 deletions docs/source/sklarpy.tests.copulas.rst
Original file line number Diff line number Diff line change
@@ -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:
61 changes: 61 additions & 0 deletions docs/source/sklarpy.tests.misc.rst
Original file line number Diff line number Diff line change
@@ -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:
45 changes: 45 additions & 0 deletions docs/source/sklarpy.tests.multivariate.rst
Original file line number Diff line number Diff line change
@@ -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:
22 changes: 22 additions & 0 deletions docs/source/sklarpy.tests.rst
Original file line number Diff line number Diff line change
@@ -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:
53 changes: 53 additions & 0 deletions docs/source/sklarpy.tests.univariate.rst
Original file line number Diff line number Diff line change
@@ -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:
Loading

0 comments on commit 7e93728

Please sign in to comment.