Skip to content

Commit

Permalink
update apidocs
Browse files Browse the repository at this point in the history
from top-level:
sphinx-apidoc -f -o docs/source thicket
  • Loading branch information
slabasan committed Sep 21, 2023
1 parent 9d2da23 commit 264b2f4
Show file tree
Hide file tree
Showing 5 changed files with 80 additions and 42 deletions.
2 changes: 1 addition & 1 deletion docs/source/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ thicket
.. toctree::
:maxdepth: 4

thicket
thicket
21 changes: 21 additions & 0 deletions docs/source/thicket.external.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
thicket.external package
========================

Submodules
----------

thicket.external.console module
-------------------------------

.. automodule:: thicket.external.console
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: thicket.external
:members:
:undoc-members:
:show-inheritance:
31 changes: 16 additions & 15 deletions docs/source/thicket.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,46 +7,47 @@ Subpackages
.. toctree::
:maxdepth: 4

thicket.external
thicket.stats
thicket.vis

Submodules
----------

thicket.helpers module
--------------------
thicket.ensemble module
-----------------------

.. automodule:: thicket.helpers
.. automodule:: thicket.ensemble
:members:
:undoc-members:
:show-inheritance:

thicket.model_extrap module
--------------------
thicket.helpers module
----------------------

.. automodule:: thicket.model_extrap
.. automodule:: thicket.helpers
:members:
:undoc-members:
:show-inheritance:

thicket.ncu module
--------------------
thicket.model\_extrap module
----------------------------

.. automodule:: thicket.ncu
.. automodule:: thicket.model_extrap
:members:
:undoc-members:
:show-inheritance:

thicket.statspreference module
--------------------
thicket.ncu module
------------------

.. automodule:: thicket.statspreference
.. automodule:: thicket.ncu
:members:
:undoc-members:
:show-inheritance:

thicket.thicket module
--------------------
----------------------

.. automodule:: thicket.thicket
:members:
Expand All @@ -62,7 +63,7 @@ thicket.utils module
:show-inheritance:

thicket.version module
--------------------
----------------------

.. automodule:: thicket.version
:members:
Expand All @@ -75,4 +76,4 @@ Module contents
.. automodule:: thicket
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
58 changes: 37 additions & 21 deletions docs/source/thicket.stats.rst
Original file line number Diff line number Diff line change
@@ -1,107 +1,123 @@
thicket.stats package
===============
=====================

Submodules
----------

thicket.stats.calc_boxplot_statistics module
--------------------
thicket.stats.calc\_boxplot\_statistics module
----------------------------------------------

.. automodule:: thicket.stats.calc_boxplot_statistics
:members:
:undoc-members:
:show-inheritance:

thicket.stats.check_normality module
--------------------
thicket.stats.check\_normality module
-------------------------------------

.. automodule:: thicket.stats.check_normality
:members:
:undoc-members:
:show-inheritance:

thicket.stats.correlation_nodewise module
--------------------
thicket.stats.correlation\_nodewise module
------------------------------------------

.. automodule:: thicket.stats.correlation_nodewise
:members:
:undoc-members:
:show-inheritance:

thicket.stats.display_boxplot module
--------------------
thicket.stats.display\_boxplot module
-------------------------------------

.. automodule:: thicket.stats.display_boxplot
:members:
:undoc-members:
:show-inheritance:

thicket.stats.display_heatmap module
--------------------
thicket.stats.display\_heatmap module
-------------------------------------

.. automodule:: thicket.stats.display_heatmap
:members:
:undoc-members:
:show-inheritance:

thicket.stats.display_histogram module
--------------------
thicket.stats.display\_histogram module
---------------------------------------

.. automodule:: thicket.stats.display_histogram
:members:
:undoc-members:
:show-inheritance:

thicket.stats.maximum module
--------------------
----------------------------

.. automodule:: thicket.stats.maximum
:members:
:undoc-members:
:show-inheritance:

thicket.stats.mean module
--------------------
-------------------------

.. automodule:: thicket.stats.mean
:members:
:undoc-members:
:show-inheritance:

thicket.stats.median module
--------------------
---------------------------

.. automodule:: thicket.stats.median
:members:
:undoc-members:
:show-inheritance:

thicket.stats.minimum module
--------------------
----------------------------

.. automodule:: thicket.stats.minimum
:members:
:undoc-members:
:show-inheritance:

thicket.stats.percentiles module
--------------------
--------------------------------

.. automodule:: thicket.stats.percentiles
:members:
:undoc-members:
:show-inheritance:

thicket.stats.preference module
-------------------------------

.. automodule:: thicket.stats.preference
:members:
:undoc-members:
:show-inheritance:

thicket.stats.std module
--------------------
------------------------

.. automodule:: thicket.stats.std
:members:
:undoc-members:
:show-inheritance:

thicket.stats.ttest module
--------------------------

.. automodule:: thicket.stats.ttest
:members:
:undoc-members:
:show-inheritance:

thicket.stats.variance module
--------------------
-----------------------------

.. automodule:: thicket.stats.variance
:members:
Expand All @@ -114,4 +130,4 @@ Module contents
.. automodule:: thicket.stats
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
10 changes: 5 additions & 5 deletions docs/source/thicket.vis.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
thicket.vis package
===============
===================

Submodules
----------

thicket.vis.static_fixer module
--------------------
thicket.vis.static\_fixer module
--------------------------------

.. automodule:: thicket.vis.static_fixer
:members:
:undoc-members:
:show-inheritance:

thicket.vis.visualizations module
--------------------
---------------------------------

.. automodule:: thicket.vis.visualizations
:members:
Expand All @@ -26,4 +26,4 @@ Module contents
.. automodule:: thicket.vis
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:

0 comments on commit 264b2f4

Please sign in to comment.