Merge pull request #18 from JuliaComputing/categories

categorize blocks
JuliaComputing · Sep 4, 2024 · 90a5a83 · 90a5a83
2 parents ed7561a + 36b99e5
commit 90a5a83
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 16 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -28,13 +28,12 @@ makedocs(;
              "Home" => "index.md",
              "Tutorials" => [
                 "Getting started with Sampled-Data Systems" => "tutorials/SampledData.md",
-                "Noise" => "tutorials/noise.md",
+                "Noise and measurement corruption" => "tutorials/noise.md",
              ],
              "Examples" => [
                 "Controlled DC motor" => "examples/dc_motor_pi.md",
              ],
-             "Block library" => "blocks.md",
-             "Functions" => "api.md",
+             "Library API" => "blocks.md",
          ],
 )
 

diff --git a/docs/src/api.md b/docs/src/api.md
diff --git a/docs/src/blocks.md b/docs/src/blocks.md
@@ -4,6 +4,27 @@
 ```@index
 ```
 
+## Basic blocks
+- [`Delay`](@ref)
+- [`Difference`](@ref)
+- [`DiscreteDerivative`](@ref)
+- [`DiscreteIntegrator`](@ref)
+- [`Sampler`](@ref)
+- [`ZeroOrderHold`](@ref)
+
+## Noise and measurement corruption
+- [`NormalNoise`](@ref)
+- [`Quantization`](@ref)
+- [`UniformNoise`](@ref)
+
+## Controllers
+- [`DiscretePIDParallel`](@ref)
+- [`DiscretePIDStandard`](@ref)
+
+## Discrete-time filters
+- [`ExponentialFilter`](@ref)
+
+
 ## Docstrings
 
 ```@autodocs