Update documentation with new organization

chromatix-team · Aug 21, 2023 · 1000ed8 · 1000ed8
1 parent 9d6d01a
commit 1000ed8
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 8 deletions.
diff --git a/docs/api/elements.md b/docs/api/elements.md
@@ -1,5 +1,8 @@
 # Elements
 
+## Utilities
+:::chromatix.elements.utils
+
 ## Sources
 :::chromatix.elements.sources
 

diff --git a/docs/api/functional.md b/docs/api/functional.md
@@ -22,4 +22,7 @@
 ::: chromatix.functional.propagation
 
 ## Polarization
-::: chromatix.functional.polarizers
+::: chromatix.functional.polarizers
+
+## Convenience
+:::chromatix.elements.convenience
diff --git a/docs/api/ops.md b/docs/api/ops.md
@@ -1,14 +1,17 @@
 # Operations
 
-:::chromatix.ops.fft
-
-:::chromatix.ops.noise
+## General
+:::chromatix.ops.ops
 
+## Filters
 :::chromatix.ops.filters
 
-:::chromatix.ops.quantization
+## Noise
+:::chromatix.ops.noise
 
-:::chromatix.ops.windows
+## Quantization
+:::chromatix.ops.quantization
 
-:::chromatix.ops.ops
+## Resample
+:::chromatix.ops.resample
 
diff --git a/docs/api/utils.md b/docs/api/utils.md
@@ -1,10 +1,16 @@
 # Utilities
 
-## Miscellanious
+## General
 :::chromatix.utils.utils
 
 ## Initializers
 :::chromatix.utils.initializers
 
+## FFT
+::: chromatix.utils.fft
+
+## Shapes
+::: chromatix.utils.shapes
+
 ## Data
 :::chromatix.utils.data