Merge pull request #290 from SciML/fm/docs

MartinuzziFrancesco · web-flow · commit 39ca9bfa42bb · 2025-06-22T12:59:58.000+02:00
docs: restructure inits api landing page
diff --git a/docs/src/api/inits.md b/docs/src/api/inits.md
@@ -2,53 +2,40 @@
 
 ## Input layers
 
-```@docs
-    chebyshev_mapping
-    informed_init
-    logistic_mapping
-    minimal_init
-    modified_lm
-    scaled_rand
-    weighted_init
-    weighted_minimal
-```
+  - [chebyshev_mapping](inits/chebyshev_mapping.md)
+  - [informed_init](inits/informed_init.md)
+  - [logistic_mapping](inits/logistic_mapping.md)
+  - [minimal_init](inits/minimal_init.md)
+  - [modified_lm](inits/modified_lm.md)
+  - [scaled_rand](inits/scaled_rand.md)
+  - [weighted_init](inits/weighted_init.md)
+  - [weighted_minimal](inits/weighted_minimal.md)
 
 ## Reservoirs
 
-```@docs
-    block_diagonal
-    chaotic_init
-    cycle_jumps
-    delay_line
-    delay_line_backward
-    double_cycle
-    forward_connection
-    low_connectivity
-    pseudo_svd
-    rand_sparse
-    selfloop_cycle
-    selfloop_delayline_backward
-    selfloop_feedback_cycle
-    selfloop_forward_connection
-    simple_cycle
-    true_double_cycle
-```
+  - [block_diagonal](inits/block_diagonal.md)
+  - [chaotic_init](inits/chaotic_init.md)
+  - [cycle_jumps](inits/cycle_jumps.md)
+  - [delay_line](inits/delay_line.md)
+  - [delay_line_backward](inits/delay_line_backward.md)
+  - [double_cycle](inits/double_cycle.md)
+  - [forward_connection](inits/forward_connection.md)
+  - [low_connectivity](inits/low_connectivity.md)
+  - [pseudo_svd](inits/pseudo_svd.md)
+  - [rand_sparse](inits/rand_sparse.md)
+  - [selfloop_cycle](inits/selfloop_cycle.md)
+  - [selfloop_delayline_backward](inits/selfloop_delayline_backward.md)
+  - [selfloop_feedback_cycle](inits/selfloop_feedback_cycle.md)
+  - [selfloop_forward_connection](inits/selfloop_forward_connection.md)
+  - [simple_cycle](inits/simple_cycle.md)
+  - [true_double_cycle](inits/true_double_cycle.md)
 
 ## Building functions
 
-```@docs
-    add_jumps!
-    backward_connection!
-    delay_line!
-    reverse_simple_cycle!
-    scale_radius!
-    self_loop!
-    simple_cycle!
-```
-
-## References
-
-```@bibliography
-Pages = ["inits.md"]
-Canonical = false
-```
+  - [add_jumps!](inits/add_jumps!.md)
+  - [backward_connection!](inits/backward_connection!.md)
+  - [delay_line!](inits/delay_line!.md)
+  - [reverse_simple_cycle!](inits/reverse_simple_cycle!.md)
+  - [scale_radius!](inits/scale_radius!.md)
+  - [self_loop!](inits/self_loop!.md)
+  - [simple_cycle!](inits/simple_cycle!.md)
diff --git a/docs/src/api/inits/add_jumps!.md b/docs/src/api/inits/add_jumps!.md
@@ -0,0 +1,5 @@
+# add_jumps!
+
+```@docs
+    add_jumps!
+```
diff --git a/docs/src/api/inits/backward_connection!.md b/docs/src/api/inits/backward_connection!.md
@@ -0,0 +1,5 @@
+# backward_connection!
+
+```@docs
+    backward_connection!
+```
diff --git a/docs/src/api/inits/block_diagonal.md b/docs/src/api/inits/block_diagonal.md
@@ -0,0 +1,12 @@
+# block_diagonal
+
+```@docs
+    block_diagonal
+```
+
+## References
+
+```@bibliography
+Pages = ["block_diagonal.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/chaotic_init.md b/docs/src/api/inits/chaotic_init.md
@@ -0,0 +1,12 @@
+# chaotic_init
+
+```@docs
+    chaotic_init
+```
+
+## References
+
+```@bibliography
+Pages = ["chaotic_init.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/chebyshev_mapping.md b/docs/src/api/inits/chebyshev_mapping.md
@@ -0,0 +1,12 @@
+# chebyshev_mapping
+
+```@docs
+    chebyshev_mapping
+```
+
+## References
+
+```@bibliography
+Pages = ["chebyshev_mapping.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/cycle_jumps.md b/docs/src/api/inits/cycle_jumps.md
@@ -0,0 +1,12 @@
+# cycle_jumps
+
+```@docs
+    cycle_jumps
+```
+
+## References
+
+```@bibliography
+Pages = ["cycle_jumps.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/delay_line!.md b/docs/src/api/inits/delay_line!.md
@@ -0,0 +1,5 @@
+# delay_line!
+
+```@docs
+    delay_line!
+```
diff --git a/docs/src/api/inits/delay_line.md b/docs/src/api/inits/delay_line.md
@@ -0,0 +1,12 @@
+# delay_line
+
+```@docs
+    delay_line
+```
+
+## References
+
+```@bibliography
+Pages = ["delay_line.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/delay_line_backward.md b/docs/src/api/inits/delay_line_backward.md
@@ -0,0 +1,12 @@
+# delay_line_backward
+
+```@docs
+    delay_line_backward
+```
+
+## References
+
+```@bibliography
+Pages = ["delay_line_backward.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/double_cycle.md b/docs/src/api/inits/double_cycle.md
@@ -0,0 +1,12 @@
+# double_cycle
+
+```@docs
+    double_cycle
+```
+
+## References
+
+```@bibliography
+Pages = ["double_cycle.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/forward_connection.md b/docs/src/api/inits/forward_connection.md
@@ -0,0 +1,12 @@
+# forward_connection
+
+```@docs
+    forward_connection
+```
+
+## References
+
+```@bibliography
+Pages = ["forward_connection.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/informed_init.md b/docs/src/api/inits/informed_init.md
@@ -0,0 +1,12 @@
+# informed_init
+
+```@docs
+    informed_init
+```
+
+## References
+
+```@bibliography
+Pages = ["informed_init.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/logistic_mapping.md b/docs/src/api/inits/logistic_mapping.md
@@ -0,0 +1,12 @@
+# logistic_mapping
+
+```@docs
+    logistic_mapping
+```
+
+## References
+
+```@bibliography
+Pages = ["logistic_mapping.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/low_connectivity.md b/docs/src/api/inits/low_connectivity.md
@@ -0,0 +1,12 @@
+# low_connectivity
+
+```@docs
+    low_connectivity
+```
+
+## References
+
+```@bibliography
+Pages = ["low_connectivity.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/minimal_init.md b/docs/src/api/inits/minimal_init.md
@@ -0,0 +1,12 @@
+# minimal_init
+
+```@docs
+    minimal_init
+```
+
+## References
+
+```@bibliography
+Pages = ["minimal_init.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/modified_lm.md b/docs/src/api/inits/modified_lm.md
@@ -0,0 +1,12 @@
+# modified_lm
+
+```@docs
+    modified_lm
+```
+
+## References
+
+```@bibliography
+Pages = ["modified_lm.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/pseudo_svd.md b/docs/src/api/inits/pseudo_svd.md
@@ -0,0 +1,12 @@
+# pseudo_svd
+
+```@docs
+    pseudo_svd
+```
+
+## References
+
+```@bibliography
+Pages = ["pseudo_svd.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/rand_sparse.md b/docs/src/api/inits/rand_sparse.md
@@ -0,0 +1,5 @@
+# rand_sparse
+
+```@docs
+    rand_sparse
+```
diff --git a/docs/src/api/inits/reverse_simple_cycle!.md b/docs/src/api/inits/reverse_simple_cycle!.md
@@ -0,0 +1,5 @@
+# reverse_simple_cycle!
+
+```@docs
+    reverse_simple_cycle!
+```
diff --git a/docs/src/api/inits/scale_radius!.md b/docs/src/api/inits/scale_radius!.md
@@ -0,0 +1,5 @@
+# scale_radius!
+
+```@docs
+    scale_radius!
+```
diff --git a/docs/src/api/inits/scaled_rand.md b/docs/src/api/inits/scaled_rand.md
@@ -0,0 +1,5 @@
+# scaled_rand
+
+```@docs
+    scaled_rand
+```
diff --git a/docs/src/api/inits/self_loop!.md b/docs/src/api/inits/self_loop!.md
@@ -0,0 +1,5 @@
+# self_loop!
+
+```@docs
+    self_loop!
+```
diff --git a/docs/src/api/inits/selfloop_cycle.md b/docs/src/api/inits/selfloop_cycle.md
@@ -0,0 +1,12 @@
+# selfloop_cycle
+
+```@docs
+    selfloop_cycle
+```
+
+## References
+
+```@bibliography
+Pages = ["selfloop_cycle.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/selfloop_delayline_backward.md b/docs/src/api/inits/selfloop_delayline_backward.md
@@ -0,0 +1,12 @@
+# selfloop_delayline_backward
+
+```@docs
+    selfloop_delayline_backward
+```
+
+## References
+
+```@bibliography
+Pages = ["selfloop_delayline_backward.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/selfloop_feedback_cycle.md b/docs/src/api/inits/selfloop_feedback_cycle.md
@@ -0,0 +1,12 @@
+# selfloop_feedback_cycle
+
+```@docs
+    selfloop_feedback_cycle
+```
+
+## References
+
+```@bibliography
+Pages = ["selfloop_feedback_cycle.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/selfloop_forward_connection.md b/docs/src/api/inits/selfloop_forward_connection.md
@@ -0,0 +1,12 @@
+# selfloop_forward_connection
+
+```@docs
+    selfloop_forward_connection
+```
+
+## References
+
+```@bibliography
+Pages = ["selfloop_forward_connection.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/simple_cycle!.md b/docs/src/api/inits/simple_cycle!.md
@@ -0,0 +1,5 @@
+# simple_cycle!
+
+```@docs
+    simple_cycle!
+```
diff --git a/docs/src/api/inits/simple_cycle.md b/docs/src/api/inits/simple_cycle.md
@@ -0,0 +1,12 @@
+# simple_cycle
+
+```@docs
+    simple_cycle
+```
+
+## References
+
+```@bibliography
+Pages = ["simple_cycle.md"]
+Canonical = false
+```
diff --git a/docs/src/api/inits/true_double_cycle.md b/docs/src/api/inits/true_double_cycle.md
diff --git a/docs/src/api/inits/weighted_init.md b/docs/src/api/inits/weighted_init.md
diff --git a/docs/src/api/inits/weighted_minimal.md b/docs/src/api/inits/weighted_minimal.md
