Skip to content

Commit 8492187

Browse files
remove literate
1 parent b85f098 commit 8492187

28 files changed

+3546
-8664
lines changed

GraphNeuralNetworks/docs/Project.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
[deps]
22
CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"
33
CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
4+
DemoCards = "311a05b2-6137-4a5a-b473-18580a3d38b5"
45
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
56
DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
7+
FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
68
Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
79
GNNGraphs = "aed8fd31-079b-4b5a-b342-a13352159b8c"
810
GNNlib = "a6a84749-d869-43f8-aacc-be26a1996e48"
@@ -14,8 +16,6 @@ Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
1416
MLDatasets = "eb30cadb-4394-5ae3-aed4-317e484a6458"
1517
MLUtils = "f1d291b0-491e-4a28-83b9-f70985020b54"
1618
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
17-
PlutoStaticHTML = "359b1769-a58e-495b-9770-312e911026ad"
18-
PlutoUI = "7f904dfe-b85e-4ff6-b463-dae2292396a8"
1919
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
2020
SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
2121
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

GraphNeuralNetworks/docs/make.jl

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Pkg.develop([
88
Pkg.instantiate()
99

1010
using Documenter
11+
using DemoCards: DemoCards
1112
using GraphNeuralNetworks
1213
using Flux, GNNGraphs, GNNlib, Graphs
1314
using DocumenterInterLinks
@@ -39,14 +40,25 @@ cp(joinpath(@__DIR__, "../../GNNGraphs/docs/src"),
3940
cp(joinpath(@__DIR__, "../../GNNlib/docs/src"),
4041
joinpath(@__DIR__, "src/GNNlib"), force=true)
4142

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+
4253
makedocs(;
4354
modules = [GraphNeuralNetworks, GNNGraphs, GNNlib],
4455
plugins = [interlinks],
4556
format = Documenter.HTML(; mathengine,
4657
prettyurls = get(ENV, "CI", nothing) == "true",
47-
assets = [],
58+
assets,
4859
size_threshold=nothing,
49-
size_threshold_warn=2000000),
60+
size_threshold_warn=2000000,
61+
example_size_threshold=2000000),
5062
sitename = "GraphNeuralNetworks.jl",
5163
pages = [
5264

@@ -58,26 +70,26 @@ makedocs(;
5870
"Models" => "guides/models.md",
5971
"Datasets" => "GNNGraphs/guides/datasets.md",
6072
"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",
7474
],
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+
# ],
7587

7688
"API Reference" => [
7789
"Graphs (GNNGraphs.jl)" => [
7890
"GNNGraph" => "GNNGraphs/api/gnngraph.md",
7991
"GNNHeteroGraph" => "GNNGraphs/api/heterograph.md",
80-
"TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
92+
# "TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
8193
"Datasets" => "GNNGraphs/api/datasets.md",
8294
]
8395

@@ -90,7 +102,7 @@ makedocs(;
90102
"Basic layers" => "api/basic.md",
91103
"Convolutional layers" => "api/conv.md",
92104
"Pooling layers" => "api/pool.md",
93-
"Temporal Convolutional layers" => "api/temporalconv.md",
105+
# "Temporal Convolutional layers" => "api/temporalconv.md",
94106
"Hetero Convolutional layers" => "api/heteroconv.md",
95107
]
96108
],
@@ -99,6 +111,7 @@ makedocs(;
99111
],
100112
)
101113

114+
tutorials_postprocess_cb()
102115
rm(joinpath(@__DIR__, "src/GNNGraphs"), force=true, recursive=true)
103116
rm(joinpath(@__DIR__, "src/GNNlib"), force=true, recursive=true)
104117

GraphNeuralNetworks/docs/src/tutorials/gnn_intro.md

Lines changed: 0 additions & 390 deletions
This file was deleted.

0 commit comments

Comments
 (0)