From 018db329d7ec5252ec1fa8f8c36845402874bace Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Dutrieux?= Date: Mon, 29 Jul 2024 15:22:57 +0200 Subject: [PATCH] Re-organized API doc and regroup it into a single file - Simplified tree - Renamed API Reference instead of simply nrt - Fixes #17 - Fixes #19 --- docs/api_reference.rst | 115 +++++++++++++++++++++++++++++++++++++++++ docs/conf.py | 2 +- docs/index.rst | 2 +- docs/nrt.data.rst | 10 ---- docs/nrt.monitor.rst | 53 ------------------- docs/nrt.rst | 70 ------------------------- 6 files changed, 117 insertions(+), 135 deletions(-) create mode 100644 docs/api_reference.rst delete mode 100644 docs/nrt.data.rst delete mode 100644 docs/nrt.monitor.rst delete mode 100644 docs/nrt.rst diff --git a/docs/api_reference.rst b/docs/api_reference.rst new file mode 100644 index 0000000..d1e666a --- /dev/null +++ b/docs/api_reference.rst @@ -0,0 +1,115 @@ +API Reference +============= + +nrt.data package +---------------- + +.. automodule:: nrt.data + :members: + :undoc-members: + :show-inheritance: + +nrt.monitor package +------------------- + +.. automodule:: nrt.monitor + :members: + :undoc-members: + :show-inheritance: + +nrt.monitor.ccdc module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: nrt.monitor.ccdc + :members: + :undoc-members: + :show-inheritance: + +nrt.monitor.cusum module +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: nrt.monitor.cusum + :members: + :undoc-members: + :show-inheritance: + +nrt.monitor.ewma module +^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: nrt.monitor.ewma + :members: + :undoc-members: + :show-inheritance: + +nrt.monitor.iqr module +^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: nrt.monitor.iqr + :members: + :undoc-members: + :show-inheritance: + +nrt.monitor.mosum module +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: nrt.monitor.mosum + :members: + :undoc-members: + :show-inheritance: + +nrt.fit\_methods module +----------------------- + +.. automodule:: nrt.fit_methods + :members: + :undoc-members: + :show-inheritance: + +nrt.log module +-------------- + +.. automodule:: nrt.log + :members: + :undoc-members: + :show-inheritance: + +nrt.outliers module +------------------- + +.. automodule:: nrt.outliers + :members: + :undoc-members: + :show-inheritance: + +nrt.stats module +---------------- + +.. automodule:: nrt.stats + :members: + :undoc-members: + :show-inheritance: + +nrt.utils module +---------------- + +.. automodule:: nrt.utils + :members: + :undoc-members: + :show-inheritance: + +nrt.utils\_efp module +--------------------- + +.. automodule:: nrt.utils_efp + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nrt + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/conf.py b/docs/conf.py index a472b30..581dcec 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -71,7 +71,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static', 'images'] +html_static_path = ['images'] html_logo = "images/logo.png" html_theme_options = { 'logo_only': True, diff --git a/docs/index.rst b/docs/index.rst index 7cc5d37..88ba922 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,7 +15,7 @@ Welcome to nrt's documentation! quickstart classes fit - nrt + api_reference auto_examples/index diff --git a/docs/nrt.data.rst b/docs/nrt.data.rst deleted file mode 100644 index 89c1840..0000000 --- a/docs/nrt.data.rst +++ /dev/null @@ -1,10 +0,0 @@ -nrt.data package -================ - -Module contents ---------------- - -.. automodule:: nrt.data - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/nrt.monitor.rst b/docs/nrt.monitor.rst deleted file mode 100644 index 1ead4ea..0000000 --- a/docs/nrt.monitor.rst +++ /dev/null @@ -1,53 +0,0 @@ -nrt.monitor package -=================== - -Submodules ----------- - -nrt.monitor.ccdc module ------------------------ - -.. automodule:: nrt.monitor.ccdc - :members: - :undoc-members: - :show-inheritance: - -nrt.monitor.cusum module ------------------------- - -.. automodule:: nrt.monitor.cusum - :members: - :undoc-members: - :show-inheritance: - -nrt.monitor.ewma module ------------------------ - -.. automodule:: nrt.monitor.ewma - :members: - :undoc-members: - :show-inheritance: - -nrt.monitor.iqr module ----------------------- - -.. automodule:: nrt.monitor.iqr - :members: - :undoc-members: - :show-inheritance: - -nrt.monitor.mosum module ------------------------- - -.. automodule:: nrt.monitor.mosum - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nrt.monitor - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/nrt.rst b/docs/nrt.rst deleted file mode 100644 index c20de78..0000000 --- a/docs/nrt.rst +++ /dev/null @@ -1,70 +0,0 @@ -nrt package -=========== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - nrt.data - nrt.monitor - -Submodules ----------- - -nrt.fit\_methods module ------------------------ - -.. automodule:: nrt.fit_methods - :members: - :undoc-members: - :show-inheritance: - -nrt.log module --------------- - -.. automodule:: nrt.log - :members: - :undoc-members: - :show-inheritance: - -nrt.outliers module -------------------- - -.. automodule:: nrt.outliers - :members: - :undoc-members: - :show-inheritance: - -nrt.stats module ----------------- - -.. automodule:: nrt.stats - :members: - :undoc-members: - :show-inheritance: - -nrt.utils module ----------------- - -.. automodule:: nrt.utils - :members: - :undoc-members: - :show-inheritance: - -nrt.utils\_efp module ---------------------- - -.. automodule:: nrt.utils_efp - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nrt - :members: - :undoc-members: - :show-inheritance: