Merge pull request #7 from CyrilJl/reorganize-api-docs

Reorganize API documentation into multiple pages

Author: CyrilJl

docs/source/api.rst

@@ -4,43 +4,10 @@ API Reference
 
 This page provides a reference for the classes available in the ``batchstats`` library.
 
-Core Classes
-------------
+.. toctree::
+   :maxdepth: 2
+   :caption: API:
+   :hidden:
 
-These are the standard classes for computing statistics on datasets. If your data contains ``NaN`` values, they will be handled by removing the entire sample (row) that contains them.
-
-.. autoclass:: batchstats.BatchSum
-   :members: update_batch, __call__
-
-.. autoclass:: batchstats.BatchMean
-   :members: update_batch, __call__
-
-.. autoclass:: batchstats.BatchVar
-   :members: update_batch, __call__
-
-.. autoclass:: batchstats.BatchStd
-   :members: update_batch, __call__
-
-.. autoclass:: batchstats.BatchCov
-   :members: update_batch, __call__
-
-.. autoclass:: batchstats.BatchMin
-   :members: update_batch, __call__
-
-.. autoclass:: batchstats.BatchMax
-   :members: update_batch, __call__
-
-.. autoclass:: batchstats.BatchPeakToPeak
-   :members: update_batch, __call__
-
-
-NaN-handling Classes
---------------------
-
-These classes are designed to handle datasets that contain ``NaN`` values, similar to ``numpy``'s ``nan*`` functions. They compute statistics by ignoring ``NaN`` values.
-
-.. autoclass:: batchstats.BatchNanSum
-   :members: update_batch, __call__
-
-.. autoclass:: batchstats.BatchNanMean
-   :members: update_batch, __call__
+   core_classes
+   nan_handling_classes

docs/source/core_classes.rst

@@ -0,0 +1,29 @@
+=============
+Core Classes
+=============
+
+These are the standard classes for computing statistics on datasets. If your data contains ``NaN`` values, they will be handled by removing the entire sample (row) that contains them.
+
+.. autoclass:: batchstats.BatchSum
+   :members: update_batch, __call__
+
+.. autoclass:: batchstats.BatchMean
+   :members: update_batch, __call__
+
+.. autoclass:: batchstats.BatchVar
+   :members: update_batch, __call__
+
+.. autoclass:: batchstats.BatchStd
+   :members: update_batch, __call__
+
+.. autoclass:: batchstats.BatchCov
+   :members: update_batch, __call__
+
+.. autoclass:: batchstats.BatchMin
+   :members: update_batch, __call__
+
+.. autoclass:: batchstats.BatchMax
+   :members: update_batch, __call__
+
+.. autoclass:: batchstats.BatchPeakToPeak
+   :members: update_batch, __call__

docs/source/nan_handling_classes.rst

@@ -0,0 +1,11 @@
+======================
+NaN-handling Classes
+======================
+
+These classes are designed to handle datasets that contain ``NaN`` values, similar to ``numpy``'s ``nan*`` functions. They compute statistics by ignoring ``NaN`` values.
+
+.. autoclass:: batchstats.BatchNanSum
+   :members: update_batch, __call__
+
+.. autoclass:: batchstats.BatchNanMean
+   :members: update_batch, __call__