From 74eb2231ed6789abe7e383d0930b2d35b6afc29a Mon Sep 17 00:00:00 2001 From: Simon Brugman Date: Mon, 27 Jun 2022 13:11:24 +0200 Subject: [PATCH] docs: update api documentation --- docs/source/popmon.alerting.rst | 1 - docs/source/popmon.analysis.comparison.rst | 9 +++- docs/source/popmon.analysis.profiling.rst | 9 +++- docs/source/popmon.analysis.rst | 2 +- docs/source/popmon.base.rst | 7 +++ docs/source/popmon.decorators.rst | 29 ++++++++++++ docs/source/popmon.hist.filling.rst | 53 ---------------------- docs/source/popmon.hist.rst | 16 ++----- docs/source/popmon.io.rst | 1 - docs/source/popmon.pipeline.rst | 1 - docs/source/popmon.rst | 11 ++++- docs/source/popmon.stats.rst | 1 - docs/source/popmon.stitching.rst | 1 - docs/source/popmon.visualization.rst | 25 +++++++++- docs/source/popmon_index.rst | 2 +- 15 files changed, 92 insertions(+), 76 deletions(-) create mode 100644 docs/source/popmon.decorators.rst diff --git a/docs/source/popmon.alerting.rst b/docs/source/popmon.alerting.rst index 6b782f1e..4f328813 100644 --- a/docs/source/popmon.alerting.rst +++ b/docs/source/popmon.alerting.rst @@ -20,7 +20,6 @@ popmon.alerting.compute\_tl\_bounds module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon.analysis.comparison.rst b/docs/source/popmon.analysis.comparison.rst index 214562e7..079d52fb 100644 --- a/docs/source/popmon.analysis.comparison.rst +++ b/docs/source/popmon.analysis.comparison.rst @@ -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 ------------------------------------------------ @@ -12,7 +20,6 @@ popmon.analysis.comparison.hist\_comparer module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon.analysis.profiling.rst b/docs/source/popmon.analysis.profiling.rst index dd4e08c8..e5dac456 100644 --- a/docs/source/popmon.analysis.profiling.rst +++ b/docs/source/popmon.analysis.profiling.rst @@ -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 ------------------------------------------------- @@ -20,7 +28,6 @@ popmon.analysis.profiling.pull\_calculator module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon.analysis.rst b/docs/source/popmon.analysis.rst index 1d2d3f34..e65a4751 100644 --- a/docs/source/popmon.analysis.rst +++ b/docs/source/popmon.analysis.rst @@ -5,6 +5,7 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 popmon.analysis.comparison popmon.analysis.profiling @@ -44,7 +45,6 @@ popmon.analysis.merge\_statistics module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon.base.rst b/docs/source/popmon.base.rst index dbec0961..7255015e 100644 --- a/docs/source/popmon.base.rst +++ b/docs/source/popmon.base.rst @@ -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 --------------- diff --git a/docs/source/popmon.decorators.rst b/docs/source/popmon.decorators.rst new file mode 100644 index 00000000..adfdb5cf --- /dev/null +++ b/docs/source/popmon.decorators.rst @@ -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: diff --git a/docs/source/popmon.hist.filling.rst b/docs/source/popmon.hist.filling.rst index f9ee6f28..84f9a030 100644 --- a/docs/source/popmon.hist.filling.rst +++ b/docs/source/popmon.hist.filling.rst @@ -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 --------------- diff --git a/docs/source/popmon.hist.rst b/docs/source/popmon.hist.rst index b8e1dd6c..c601328c 100644 --- a/docs/source/popmon.hist.rst +++ b/docs/source/popmon.hist.rst @@ -5,6 +5,7 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 popmon.hist.filling @@ -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 --------------- diff --git a/docs/source/popmon.io.rst b/docs/source/popmon.io.rst index eadae921..a1a42ab0 100644 --- a/docs/source/popmon.io.rst +++ b/docs/source/popmon.io.rst @@ -28,7 +28,6 @@ popmon.io.json\_reader module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon.pipeline.rst b/docs/source/popmon.pipeline.rst index 6359282e..d294e08c 100644 --- a/docs/source/popmon.pipeline.rst +++ b/docs/source/popmon.pipeline.rst @@ -44,7 +44,6 @@ popmon.pipeline.report\_pipelines module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon.rst b/docs/source/popmon.rst index 714ecfff..471aaf3c 100644 --- a/docs/source/popmon.rst +++ b/docs/source/popmon.rst @@ -5,10 +5,12 @@ Subpackages ----------- .. toctree:: + :maxdepth: 4 popmon.alerting popmon.analysis popmon.base + popmon.decorators popmon.hist popmon.io popmon.pipeline @@ -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 --------------------- @@ -43,7 +53,6 @@ popmon.version module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon.stats.rst b/docs/source/popmon.stats.rst index 91fc4371..fd8b5567 100644 --- a/docs/source/popmon.stats.rst +++ b/docs/source/popmon.stats.rst @@ -12,7 +12,6 @@ popmon.stats.numpy module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon.stitching.rst b/docs/source/popmon.stitching.rst index fe815c89..99f2a271 100644 --- a/docs/source/popmon.stitching.rst +++ b/docs/source/popmon.stitching.rst @@ -12,7 +12,6 @@ popmon.stitching.hist\_stitcher module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon.visualization.rst b/docs/source/popmon.visualization.rst index ff4077e5..b006ff3e 100644 --- a/docs/source/popmon.visualization.rst +++ b/docs/source/popmon.visualization.rst @@ -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 ----------------------------------- @@ -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 --------------------------------------------- @@ -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 --------------------------------- @@ -44,7 +68,6 @@ popmon.visualization.utils module :undoc-members: :show-inheritance: - Module contents --------------- diff --git a/docs/source/popmon_index.rst b/docs/source/popmon_index.rst index 8b089dd2..47ebae48 100644 --- a/docs/source/popmon_index.rst +++ b/docs/source/popmon_index.rst @@ -1,4 +1,4 @@ -popmon +POPMON ====== .. toctree::