Skip to content

Commit

Permalink
docs: update api documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@sbrugman
sbrugman committed Jun 27, 2022
1 parent 610c8ad commit f4fb753
Show file tree
Hide file tree
Showing 15 changed files with 92 additions and 76 deletions.
1 change: 0 additions & 1 deletion docs/source/popmon.alerting.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ popmon.alerting.compute\_tl\_bounds module
:undoc-members:
:show-inheritance:


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

Expand Down
9 changes: 8 additions & 1 deletion docs/source/popmon.analysis.comparison.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ popmon.analysis.comparison package
Submodules
----------

popmon.analysis.comparison.comparisons module
---------------------------------------------

.. automodule:: popmon.analysis.comparison.comparisons
:members:
:undoc-members:
:show-inheritance:

popmon.analysis.comparison.hist\_comparer module
------------------------------------------------

Expand All @@ -12,7 +20,6 @@ popmon.analysis.comparison.hist\_comparer module
:undoc-members:
:show-inheritance:


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

Expand Down
9 changes: 8 additions & 1 deletion docs/source/popmon.analysis.profiling.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ popmon.analysis.profiling.hist\_profiler module
:undoc-members:
:show-inheritance:

popmon.analysis.profiling.profiles module
-----------------------------------------

.. automodule:: popmon.analysis.profiling.profiles
:members:
:undoc-members:
:show-inheritance:

popmon.analysis.profiling.pull\_calculator module
-------------------------------------------------

Expand All @@ -20,7 +28,6 @@ popmon.analysis.profiling.pull\_calculator module
:undoc-members:
:show-inheritance:


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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/popmon.analysis.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Subpackages
-----------

.. toctree::
:maxdepth: 4

popmon.analysis.comparison
popmon.analysis.profiling
Expand Down Expand Up @@ -44,7 +45,6 @@ popmon.analysis.merge\_statistics module
:undoc-members:
:show-inheritance:


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

Expand Down
7 changes: 7 additions & 0 deletions docs/source/popmon.base.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ popmon.base.pipeline module
:undoc-members:
:show-inheritance:

popmon.base.registry module
---------------------------

.. automodule:: popmon.base.registry
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------
Expand Down
29 changes: 29 additions & 0 deletions docs/source/popmon.decorators.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
popmon.decorators package
=========================

Submodules
----------

popmon.decorators.pandas module
-------------------------------

.. automodule:: popmon.decorators.pandas
:members:
:undoc-members:
:show-inheritance:

popmon.decorators.spark module
------------------------------

.. automodule:: popmon.decorators.spark
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: popmon.decorators
:members:
:undoc-members:
:show-inheritance:
53 changes: 0 additions & 53 deletions docs/source/popmon.hist.filling.rst
View file
Original file line number Diff line number Diff line change
@@ -1,59 +1,6 @@
popmon.hist.filling package
===========================

Submodules
----------

popmon.hist.filling.histogram\_filler\_base module
--------------------------------------------------

.. automodule:: popmon.hist.filling.histogram_filler_base
:members:
:undoc-members:
:show-inheritance:

popmon.hist.filling.make\_histograms module
-------------------------------------------

.. automodule:: popmon.hist.filling.make_histograms
:members:
:undoc-members:
:show-inheritance:
:noindex:

popmon.hist.filling.numpy\_histogrammar module
----------------------------------------------

.. automodule:: popmon.hist.filling.numpy_histogrammar
:members:
:undoc-members:
:show-inheritance:

popmon.hist.filling.pandas\_histogrammar module
-----------------------------------------------

.. automodule:: popmon.hist.filling.pandas_histogrammar
:members:
:undoc-members:
:show-inheritance:

popmon.hist.filling.spark\_histogrammar module
----------------------------------------------

.. automodule:: popmon.hist.filling.spark_histogrammar
:members:
:undoc-members:
:show-inheritance:

popmon.hist.filling.utils module
--------------------------------

.. automodule:: popmon.hist.filling.utils
:members:
:undoc-members:
:show-inheritance:


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

Expand Down
16 changes: 4 additions & 12 deletions docs/source/popmon.hist.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Subpackages
-----------

.. toctree::
:maxdepth: 4

popmon.hist.filling

Expand All @@ -19,23 +20,14 @@ popmon.hist.hist\_splitter module
:undoc-members:
:show-inheritance:

popmon.hist.histogram module
----------------------------
popmon.hist.hist\_utils module
------------------------------

.. automodule:: popmon.hist.histogram
.. automodule:: popmon.hist.hist_utils
:members:
:undoc-members:
:show-inheritance:

popmon.hist.patched\_histogrammer module
----------------------------------------

.. automodule:: popmon.hist.patched_histogrammer
:members:
:undoc-members:
:show-inheritance:


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

Expand Down
1 change: 0 additions & 1 deletion docs/source/popmon.io.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ popmon.io.json\_reader module
:undoc-members:
:show-inheritance:


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

Expand Down
1 change: 0 additions & 1 deletion docs/source/popmon.pipeline.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ popmon.pipeline.report\_pipelines module
:undoc-members:
:show-inheritance:


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

Expand Down
11 changes: 10 additions & 1 deletion docs/source/popmon.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ Subpackages
-----------

.. toctree::
:maxdepth: 4

popmon.alerting
popmon.analysis
popmon.base
popmon.decorators
popmon.hist
popmon.io
popmon.pipeline
Expand All @@ -35,6 +37,14 @@ popmon.resources module
:undoc-members:
:show-inheritance:

popmon.utils module
-------------------

.. automodule:: popmon.utils
:members:
:undoc-members:
:show-inheritance:

popmon.version module
---------------------

Expand All @@ -43,7 +53,6 @@ popmon.version module
:undoc-members:
:show-inheritance:


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

Expand Down
1 change: 0 additions & 1 deletion docs/source/popmon.stats.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ popmon.stats.numpy module
:undoc-members:
:show-inheritance:


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

Expand Down
1 change: 0 additions & 1 deletion docs/source/popmon.stitching.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ popmon.stitching.hist\_stitcher module
:undoc-members:
:show-inheritance:


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

Expand Down
25 changes: 24 additions & 1 deletion docs/source/popmon.visualization.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ popmon.visualization package
Submodules
----------

popmon.visualization.alert\_section\_generator module
-----------------------------------------------------

.. automodule:: popmon.visualization.alert_section_generator
:members:
:undoc-members:
:show-inheritance:

popmon.visualization.backend module
-----------------------------------

Expand All @@ -20,6 +28,14 @@ popmon.visualization.histogram\_section module
:undoc-members:
:show-inheritance:

popmon.visualization.overview\_section module
---------------------------------------------

.. automodule:: popmon.visualization.overview_section
:members:
:undoc-members:
:show-inheritance:

popmon.visualization.report\_generator module
---------------------------------------------

Expand All @@ -36,6 +52,14 @@ popmon.visualization.section\_generator module
:undoc-members:
:show-inheritance:

popmon.visualization.traffic\_light\_section\_generator module
--------------------------------------------------------------

.. automodule:: popmon.visualization.traffic_light_section_generator
:members:
:undoc-members:
:show-inheritance:

popmon.visualization.utils module
---------------------------------

Expand All @@ -44,7 +68,6 @@ popmon.visualization.utils module
:undoc-members:
:show-inheritance:


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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/popmon_index.rst
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
popmon
POPMON
======

.. toctree::
Expand Down

0 comments on commit f4fb753

Please sign in to comment.