Skip to content

Commit 39ca9bf

Browse files
Merge pull request #290 from SciML/fm/docs
docs: restructure inits api landing page
2 parents e7875d2 + ba7fb10 commit 39ca9bf

32 files changed

+340
-44
lines changed

docs/src/api/inits.md

Lines changed: 31 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,40 @@
22

33
## Input layers
44

5-
```@docs
6-
chebyshev_mapping
7-
informed_init
8-
logistic_mapping
9-
minimal_init
10-
modified_lm
11-
scaled_rand
12-
weighted_init
13-
weighted_minimal
14-
```
5+
- [chebyshev_mapping](inits/chebyshev_mapping.md)
6+
- [informed_init](inits/informed_init.md)
7+
- [logistic_mapping](inits/logistic_mapping.md)
8+
- [minimal_init](inits/minimal_init.md)
9+
- [modified_lm](inits/modified_lm.md)
10+
- [scaled_rand](inits/scaled_rand.md)
11+
- [weighted_init](inits/weighted_init.md)
12+
- [weighted_minimal](inits/weighted_minimal.md)
1513

1614
## Reservoirs
1715

18-
```@docs
19-
block_diagonal
20-
chaotic_init
21-
cycle_jumps
22-
delay_line
23-
delay_line_backward
24-
double_cycle
25-
forward_connection
26-
low_connectivity
27-
pseudo_svd
28-
rand_sparse
29-
selfloop_cycle
30-
selfloop_delayline_backward
31-
selfloop_feedback_cycle
32-
selfloop_forward_connection
33-
simple_cycle
34-
true_double_cycle
35-
```
16+
- [block_diagonal](inits/block_diagonal.md)
17+
- [chaotic_init](inits/chaotic_init.md)
18+
- [cycle_jumps](inits/cycle_jumps.md)
19+
- [delay_line](inits/delay_line.md)
20+
- [delay_line_backward](inits/delay_line_backward.md)
21+
- [double_cycle](inits/double_cycle.md)
22+
- [forward_connection](inits/forward_connection.md)
23+
- [low_connectivity](inits/low_connectivity.md)
24+
- [pseudo_svd](inits/pseudo_svd.md)
25+
- [rand_sparse](inits/rand_sparse.md)
26+
- [selfloop_cycle](inits/selfloop_cycle.md)
27+
- [selfloop_delayline_backward](inits/selfloop_delayline_backward.md)
28+
- [selfloop_feedback_cycle](inits/selfloop_feedback_cycle.md)
29+
- [selfloop_forward_connection](inits/selfloop_forward_connection.md)
30+
- [simple_cycle](inits/simple_cycle.md)
31+
- [true_double_cycle](inits/true_double_cycle.md)
3632

3733
## Building functions
3834

39-
```@docs
40-
add_jumps!
41-
backward_connection!
42-
delay_line!
43-
reverse_simple_cycle!
44-
scale_radius!
45-
self_loop!
46-
simple_cycle!
47-
```
48-
49-
## References
50-
51-
```@bibliography
52-
Pages = ["inits.md"]
53-
Canonical = false
54-
```
35+
- [add_jumps!](inits/add_jumps!.md)
36+
- [backward_connection!](inits/backward_connection!.md)
37+
- [delay_line!](inits/delay_line!.md)
38+
- [reverse_simple_cycle!](inits/reverse_simple_cycle!.md)
39+
- [scale_radius!](inits/scale_radius!.md)
40+
- [self_loop!](inits/self_loop!.md)
41+
- [simple_cycle!](inits/simple_cycle!.md)

docs/src/api/inits/add_jumps!.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# add_jumps!
2+
3+
```@docs
4+
add_jumps!
5+
```
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# backward_connection!
2+
3+
```@docs
4+
backward_connection!
5+
```

docs/src/api/inits/block_diagonal.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# block_diagonal
2+
3+
```@docs
4+
block_diagonal
5+
```
6+
7+
## References
8+
9+
```@bibliography
10+
Pages = ["block_diagonal.md"]
11+
Canonical = false
12+
```

docs/src/api/inits/chaotic_init.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# chaotic_init
2+
3+
```@docs
4+
chaotic_init
5+
```
6+
7+
## References
8+
9+
```@bibliography
10+
Pages = ["chaotic_init.md"]
11+
Canonical = false
12+
```
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# chebyshev_mapping
2+
3+
```@docs
4+
chebyshev_mapping
5+
```
6+
7+
## References
8+
9+
```@bibliography
10+
Pages = ["chebyshev_mapping.md"]
11+
Canonical = false
12+
```

docs/src/api/inits/cycle_jumps.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# cycle_jumps
2+
3+
```@docs
4+
cycle_jumps
5+
```
6+
7+
## References
8+
9+
```@bibliography
10+
Pages = ["cycle_jumps.md"]
11+
Canonical = false
12+
```

docs/src/api/inits/delay_line!.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# delay_line!
2+
3+
```@docs
4+
delay_line!
5+
```

docs/src/api/inits/delay_line.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# delay_line
2+
3+
```@docs
4+
delay_line
5+
```
6+
7+
## References
8+
9+
```@bibliography
10+
Pages = ["delay_line.md"]
11+
Canonical = false
12+
```
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# delay_line_backward
2+
3+
```@docs
4+
delay_line_backward
5+
```
6+
7+
## References
8+
9+
```@bibliography
10+
Pages = ["delay_line_backward.md"]
11+
Canonical = false
12+
```

0 commit comments

Comments
 (0)