@@ -8,6 +8,7 @@ Pkg.develop([
8
8
Pkg. instantiate ()
9
9
10
10
using Documenter
11
+ using DemoCards: DemoCards
11
12
using GraphNeuralNetworks
12
13
using Flux, GNNGraphs, GNNlib, Graphs
13
14
using DocumenterInterLinks
@@ -39,14 +40,25 @@ cp(joinpath(@__DIR__, "../../GNNGraphs/docs/src"),
39
40
cp (joinpath (@__DIR__ , " ../../GNNlib/docs/src" ),
40
41
joinpath (@__DIR__ , " src/GNNlib" ), force= true )
41
42
43
+
44
+
45
+ tutorials, tutorials_postprocess_cb, tutorials_assets = DemoCards. makedemos (joinpath (@__DIR__ , " tutorials" ))
46
+
47
+ # # UNCOMMENT TO DISABLE TUTORIALS AND SPEED UP DOCS BUILDING
48
+ # tutorials, tutorials_postprocess_cb, tutorials_assets = [], _ -> nothing, nothing
49
+
50
+ assets = []
51
+ isnothing (tutorials_assets) || push! (assets, tutorials_assets)
52
+
42
53
makedocs (;
43
54
modules = [GraphNeuralNetworks, GNNGraphs, GNNlib],
44
55
plugins = [interlinks],
45
56
format = Documenter. HTML (; mathengine,
46
57
prettyurls = get (ENV , " CI" , nothing ) == " true" ,
47
- assets = [] ,
58
+ assets,
48
59
size_threshold= nothing ,
49
- size_threshold_warn= 2000000 ),
60
+ size_threshold_warn= 2000000 ,
61
+ example_size_threshold= 2000000 ),
50
62
sitename = " GraphNeuralNetworks.jl" ,
51
63
pages = [
52
64
@@ -58,26 +70,26 @@ makedocs(;
58
70
" Models" => " guides/models.md" ,
59
71
" Datasets" => " GNNGraphs/guides/datasets.md" ,
60
72
" Heterogeneous Graphs" => " GNNGraphs/guides/heterograph.md" ,
61
- " Temporal Graphs" => " GNNGraphs/guides/temporalgraph.md" ,
62
- ],
63
-
64
- " Tutorials" => [
65
- " Introductory tutorials" => [
66
- " Hands on" => " tutorials/gnn_intro.md" ,
67
- " Node classification" => " tutorials/node_classification.md" ,
68
- " Graph classification" => " tutorials/graph_classification.md"
69
- ],
70
- " Temporal graph neural networks" => [
71
- " Node autoregression" => " tutorials/traffic_prediction.md" ,
72
- " Temporal graph classification" => " tutorials/temporal_graph_classification.md"
73
- ],
73
+ # "Temporal Graphs" => "GNNGraphs/guides/temporalgraph.md",
74
74
],
75
+ tutorials,
76
+ # "Tutorials" => [
77
+ # "Introductory tutorials" => [
78
+ # "Hands on" => "tutorials/beginner_tutorials/gnn_intro.md",
79
+ # "Node classification" => "tutorials/beginner_tutorials/node_classification.md",
80
+ # "Graph classification" => "tutorials/beginner_tutorials/graph_classification.md"
81
+ # ],
82
+ # "Temporal graph neural networks" =>[
83
+ # "Node autoregression" => "tutorials/traffic_prediction.md",
84
+ # "Temporal graph classification" => "tutorials/temporal_graph_classification.md"
85
+ # ],
86
+ # ],
75
87
76
88
" API Reference" => [
77
89
" Graphs (GNNGraphs.jl)" => [
78
90
" GNNGraph" => " GNNGraphs/api/gnngraph.md" ,
79
91
" GNNHeteroGraph" => " GNNGraphs/api/heterograph.md" ,
80
- " TemporalSnapshotsGNNGraph" => " GNNGraphs/api/temporalgraph.md" ,
92
+ # "TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
81
93
" Datasets" => " GNNGraphs/api/datasets.md" ,
82
94
]
83
95
@@ -90,7 +102,7 @@ makedocs(;
90
102
" Basic layers" => " api/basic.md" ,
91
103
" Convolutional layers" => " api/conv.md" ,
92
104
" Pooling layers" => " api/pool.md" ,
93
- " Temporal Convolutional layers" => " api/temporalconv.md" ,
105
+ # "Temporal Convolutional layers" => "api/temporalconv.md",
94
106
" Hetero Convolutional layers" => " api/heteroconv.md" ,
95
107
]
96
108
],
@@ -99,6 +111,7 @@ makedocs(;
99
111
],
100
112
)
101
113
114
+ tutorials_postprocess_cb ()
102
115
rm (joinpath (@__DIR__ , " src/GNNGraphs" ), force= true , recursive= true )
103
116
rm (joinpath (@__DIR__ , " src/GNNlib" ), force= true , recursive= true )
104
117
0 commit comments