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

@@ -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:
+

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,

docs/index.rst

@@ -15,7 +15,7 @@ Welcome to nrt's documentation!
    quickstart
    classes
    fit
-   nrt
+   api_reference
    auto_examples/index