Skip to content

Commit 4ea66c7

Browse files
committed
docs: restructure internals and public pages
1 parent d70ca7c commit 4ea66c7

File tree

2 files changed

+56
-75
lines changed

2 files changed

+56
-75
lines changed

docs/src/library/internals.md

Lines changed: 12 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -4,94 +4,34 @@ Documentation for `JunctionTrees.jl`'s internals.
44

55
## Index
66

7+
[Types](@ref internals_Types)
8+
79
```@index
810
Pages = ["internals.md"]
11+
Order = [:type]
912
```
1013

11-
## Factors
12-
13-
```@autodocs
14-
Modules = [JunctionTrees]
15-
Pages = ["factors.jl"]
16-
Public = false
17-
```
18-
19-
## Junction tree algorithm
14+
[Functions](@ref internals_Functions)
2015

21-
```@autodocs
22-
Modules = [JunctionTrees]
23-
Pages = ["junction_tree_algorithm.jl"]
24-
Public = false
25-
```
26-
27-
### Graphical transformation
28-
29-
```@autodocs
30-
Modules = [JunctionTrees]
31-
Pages = ["graphical_transformation.jl"]
32-
Public = false
33-
```
34-
35-
### Initialization
36-
37-
```@autodocs
38-
Modules = [JunctionTrees]
39-
Pages = ["initialization.jl"]
40-
Public = false
41-
```
42-
43-
### Observation entry
44-
45-
```@autodocs
46-
Modules = [JunctionTrees]
47-
Pages = ["observation_entry.jl"]
48-
Public = false
49-
```
50-
51-
### Propagation
52-
53-
```@autodocs
54-
Modules = [JunctionTrees]
55-
Pages = ["propagation.jl"]
56-
Public = false
57-
```
58-
59-
### Marginalization
60-
61-
```@autodocs
62-
Modules = [JunctionTrees]
63-
Pages = ["marginalization.jl"]
64-
Public = false
65-
```
66-
67-
### Normalization
68-
69-
```@autodocs
70-
Modules = [JunctionTrees]
71-
Pages = ["normalization.jl"]
72-
Public = false
16+
```@index
17+
Pages = ["internals.md"]
18+
Order = [:function]
7319
```
7420

75-
## Partial Evaluation
76-
77-
```@autodocs
78-
Modules = [JunctionTrees]
79-
Pages = ["partial_evaluation.jl"]
80-
Public = false
81-
```
21+
## Internals interface
8222

83-
## Abstract Trees
23+
### [Types](@id internals_Types)
8424

8525
```@autodocs
8626
Modules = [JunctionTrees]
87-
Pages = ["tree.jl"]
27+
Order = [:type]
8828
Public = false
8929
```
9030

91-
## Utils
31+
### [Functions](@id internals_Functions)
9232

9333
```@autodocs
9434
Modules = [JunctionTrees]
95-
Pages = ["utils.jl"]
35+
Order = [:function]
9636
Public = false
9737
```

docs/src/library/public.md

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,62 @@ Documentation for `JunctionTrees.jl`'s public interface.
44

55
## Index
66

7+
[Modules](@ref)
8+
79
```@index
810
Pages = ["public.md"]
11+
Order = [:module]
912
```
1013

11-
## Public Interface
14+
[Types](@ref)
15+
16+
```@index
17+
Pages = ["public.md"]
18+
Order = [:type]
19+
```
20+
21+
[Functions](@ref)
22+
23+
```@index
24+
Pages = ["public.md"]
25+
Order = [:function]
26+
```
27+
28+
[Constants](@ref)
29+
30+
```@index
31+
Pages = ["public.md"]
32+
Order = [:constant]
33+
```
34+
35+
## Public interface
36+
37+
### Modules
1238

1339
```@docs
1440
JunctionTrees
15-
compile_algo
41+
```
42+
43+
### Types
44+
45+
```@docs
1646
Factor
47+
LastStage
48+
```
49+
50+
### Functions
51+
52+
```@docs
53+
compile_algo
1754
product
1855
marg
1956
redu
2057
norm
21-
LastStage
58+
```
59+
60+
### Constants
61+
62+
```@docs
2263
ForwardPass
2364
BackwardPass
2465
JointMarginals

0 commit comments

Comments
 (0)