Split API

EIT-ALIVE · Oct 9, 2024 · deb948c · deb948c
1 parent aa433b0
commit deb948c
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 5 deletions.
diff --git a/docs/APIindex.md b/docs/APIindex.md
diff --git a/docs/api/categories.md b/docs/api/categories.md
@@ -0,0 +1,3 @@
+# Categories
+
+::: eitprocessing.categories.Category
diff --git a/docs/api/datacontainers.md b/docs/api/datacontainers.md
@@ -0,0 +1,17 @@
+# Data containers
+
+::: eitprocessing.datahandling.sequence.Sequence
+
+::: eitprocessing.datahandling.eitdata.EITData
+
+::: eitprocessing.datahandling.continuousdata.ContinuousData
+
+::: eitprocessing.datahandling.sparsedata.SparseData
+
+::: eitprocessing.datahandling.intervaldata.IntervalData
+
+::: eitprocessing.datahandling.datacollection.DataCollection
+
+::: eitprocessing.datahandling.breath.Breath
+
+::: eitprocessing.datahandling.event.Event
diff --git a/docs/api/features.md b/docs/api/features.md
@@ -0,0 +1,6 @@
+# Feature extraction
+
+::: eitprocessing.features.breath_detection.BreathDetection
+
+
+::: eitprocessing.features.moving_average.MovingAverage
diff --git a/docs/api/filters.md b/docs/api/filters.md
@@ -0,0 +1,12 @@
+# Filters
+
+::: eitprocessing.filters.butterworth_filters.LowPassFilter
+
+::: eitprocessing.filters.butterworth_filters.HighPassFilter
+
+::: eitprocessing.filters.butterworth_filters.BandStopFilter
+
+::: eitprocessing.filters.butterworth_filters.BandPassFilter
+
+::: eitprocessing.filters.butterworth_filters.ButterworthFilter
+
diff --git a/docs/api/loading.md b/docs/api/loading.md
@@ -0,0 +1,3 @@
+# Loading functions
+
+::: eitprocessing.datahandling.loading.load_eit_data
diff --git a/docs/api/parameters.md b/docs/api/parameters.md
@@ -0,0 +1,3 @@
+# Parameters
+
+::: eitprocessing.parameters.eeli.EELI
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -48,7 +48,13 @@ nav:
 - Getting started:
   - Installation: installation.md
   - Basic example: basic_example.md
-- API Documentation: APIindex.md
+- API Documentation: 
+  - api/loading.md
+  - api/datacontainers.md
+  - api/filters.md
+  - api/features.md
+  - api/parameters.md
+  - api/categories.md
 - About:
   - Contributing: contributing_doc.md
   - Code of Conduct: code_of_conduct_doc.md