From 1000ed8c3d59c926ab550bd1f4c5afc5f9f316a1 Mon Sep 17 00:00:00 2001 From: Diptodip Date: Mon, 21 Aug 2023 16:09:40 -0400 Subject: [PATCH] Update documentation with new organization --- docs/api/elements.md | 3 +++ docs/api/functional.md | 5 ++++- docs/api/ops.md | 15 +++++++++------ docs/api/utils.md | 8 +++++++- 4 files changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/api/elements.md b/docs/api/elements.md index a275d28..7b75e94 100644 --- 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 index 98797ee..e6f7d8e 100644 --- a/docs/api/functional.md +++ b/docs/api/functional.md @@ -22,4 +22,7 @@ ::: chromatix.functional.propagation ## Polarization -::: chromatix.functional.polarizers \ No newline at end of file +::: chromatix.functional.polarizers + +## Convenience +:::chromatix.elements.convenience diff --git a/docs/api/ops.md b/docs/api/ops.md index 9b5368d..0038f01 100644 --- 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 index ce01808..31f7c5f 100644 --- 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