Skip to content

Commit 4d711e8

Browse files
CarloLucibelloCarloLucibello
committed
try new approach for building and deploying docs
1 parent 7bd58c6 commit 4d711e8

File tree

8 files changed

+195
-228
lines changed

8 files changed

+195
-228
lines changed

‎GNNGraphs/docs/Project.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33
DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
44
GNNGraphs = "aed8fd31-079b-4b5a-b342-a13352159b8c"
55
Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
6-
LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
76
MLDatasets = "eb30cadb-4394-5ae3-aed4-317e484a6458"
87
MLUtils = "f1d291b0-491e-4a28-83b9-f70985020b54"
98
SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"

‎GNNGraphs/docs/make.jl‎

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
using Pkg
2+
Pkg.activate(@__DIR__)
3+
Pkg.develop(path=joinpath(@__DIR__, ".."))
4+
Pkg.instantiate()
5+
16
using Documenter
27
using DocumenterInterLinks
38
using GNNGraphs
@@ -27,25 +32,28 @@ makedocs(;
2732
size_threshold=nothing,
2833
size_threshold_warn=200000),sitename = "GNNGraphs.jl",
2934
pages = [
30-
"Home" => "index.md",
31-
32-
"Guides" => [
33-
"Graphs" => "guides/gnngraph.md",
34-
"Heterogeneous Graphs" => "guides/heterograph.md",
35-
"Temporal Graphs" => "guides/temporalgraph.md",
36-
"Datasets" => "guides/datasets.md",
37-
],
35+
"Home" => "index.md",
36+
37+
"Guides" => [
38+
"Graphs" => "guides/gnngraph.md",
39+
"Heterogeneous Graphs" => "guides/heterograph.md",
40+
"Temporal Graphs" => "guides/temporalgraph.md",
41+
"Datasets" => "guides/datasets.md",
42+
],
3843

39-
"API Reference" => [
40-
"GNNGraph" => "api/gnngraph.md",
41-
"GNNHeteroGraph" => "api/heterograph.md",
42-
"TemporalSnapshotsGNNGraph" => "api/temporalgraph.md",
43-
"Samplers" => "api/samplers.md",
44+
"API Reference" => [
45+
"GNNGraph" => "api/gnngraph.md",
46+
"GNNHeteroGraph" => "api/heterograph.md",
47+
"TemporalSnapshotsGNNGraph" => "api/temporalgraph.md",
48+
"Samplers" => "api/samplers.md",
4449
],
4550
]
4651
)
47-
48-
deploydocs(repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git",
49-
devbranch = "master",
50-
dirname = "GNNGraphs",
51-
tag_prefix="GNNGraphs-")
52+
53+
deploydocs(
54+
repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl",
55+
target = "build",
56+
branch = "docs-gnngraphs",
57+
devbranch = "master",
58+
tag_prefix="GNNGraphs-",
59+
)

‎GNNLux/docs/make.jl‎

Lines changed: 60 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
using Pkg
2+
Pkg.activate(@__DIR__)
3+
Pkg.develop(path=joinpath(@__DIR__, "..", "..", "GNNGraphs"))
4+
Pkg.develop(path=joinpath(@__DIR__, "..", "..", "GNNlib"))
5+
Pkg.develop(path=joinpath(@__DIR__, ".."))
6+
Pkg.instantiate()
7+
18
using Documenter
29
using GNNLux
310
using Lux, GNNGraphs, GNNlib, Graphs
@@ -18,9 +25,7 @@ mathengine = MathJax3(Dict(:loader => Dict("load" => ["[tex]/require", "[tex]/ma
1825

1926
interlinks = InterLinks(
2027
"NNlib" => "https://fluxml.ai/NNlib.jl/stable/",
21-
# "GNNGraphs" => ("https://carlolucibello.github.io/GraphNeuralNetworks.jl/GNNGraphs/", joinpath(dirname(dirname(@__DIR__)), "GNNGraphs", "docs", "build", "objects.inv")),
22-
# "GNNlib" => ("https://carlolucibello.github.io/GraphNeuralNetworks.jl/GNNlib/", joinpath(dirname(dirname(@__DIR__)), "GNNlib", "docs", "build", "objects.inv"))
23-
)
28+
)
2429

2530
# Copy the docs from GNNGraphs and GNNlib. Will be removed at the end of the script
2631
cp(joinpath(@__DIR__, "../../GNNGraphs/docs/src"),
@@ -29,64 +34,66 @@ cp(joinpath(@__DIR__, "../../GNNlib/docs/src"),
2934
joinpath(@__DIR__, "src/GNNlib"), force=true)
3035

3136
makedocs(;
32-
modules = [GNNLux, GNNGraphs, GNNlib],
33-
doctest = false, # TODO: enable doctest
34-
plugins = [interlinks],
35-
format = Documenter.HTML(; mathengine,
36-
prettyurls = get(ENV, "CI", nothing) == "true",
37-
assets = [],
38-
size_threshold=nothing,
39-
size_threshold_warn=2000000),
40-
sitename = "GNNLux.jl",
41-
pages = [
37+
modules = [GNNLux, GNNGraphs, GNNlib],
38+
doctest = false, # TODO: enable doctest
39+
plugins = [interlinks],
40+
format = Documenter.HTML(; mathengine,
41+
prettyurls = get(ENV, "CI", nothing) == "true",
42+
assets = [],
43+
size_threshold=nothing,
44+
size_threshold_warn=2000000),
45+
sitename = "GNNLux.jl",
46+
pages = [
47+
48+
"Home" => "index.md",
4249

43-
"Home" => "index.md",
44-
45-
"Guides" => [
46-
"Graphs" => "GNNGraphs/guides/gnngraph.md",
47-
"Message Passing" => "GNNlib/guides/messagepassing.md",
48-
"Models" => "guides/models.md",
49-
"Datasets" => "GNNGraphs/guides/datasets.md",
50-
"Heterogeneous Graphs" => "GNNGraphs/guides/heterograph.md",
51-
"Temporal Graphs" => "GNNGraphs/guides/temporalgraph.md",
52-
],
50+
"Guides" => [
51+
"Graphs" => "GNNGraphs/guides/gnngraph.md",
52+
"Message Passing" => "GNNlib/guides/messagepassing.md",
53+
"Models" => "guides/models.md",
54+
"Datasets" => "GNNGraphs/guides/datasets.md",
55+
"Heterogeneous Graphs" => "GNNGraphs/guides/heterograph.md",
56+
"Temporal Graphs" => "GNNGraphs/guides/temporalgraph.md",
57+
],
5358

54-
"Tutorials" => [
55-
"Introductory tutorials" => [
56-
"Hands on" => "tutorials/gnn_intro.md",
59+
"Tutorials" => [
60+
"Introductory tutorials" => [
61+
"Hands on" => "tutorials/gnn_intro.md",
62+
],
5763
],
58-
],
5964

60-
"API Reference" => [
61-
"Graphs (GNNGraphs.jl)" => [
62-
"GNNGraph" => "GNNGraphs/api/gnngraph.md",
63-
"GNNHeteroGraph" => "GNNGraphs/api/heterograph.md",
64-
"TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
65-
"Samplers" => "GNNGraphs/api/samplers.md",
66-
]
65+
"API Reference" => [
66+
"Graphs (GNNGraphs.jl)" => [
67+
"GNNGraph" => "GNNGraphs/api/gnngraph.md",
68+
"GNNHeteroGraph" => "GNNGraphs/api/heterograph.md",
69+
"TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
70+
"Samplers" => "GNNGraphs/api/samplers.md",
71+
]
6772

68-
"Message Passing (GNNlib.jl)" => [
69-
"Message Passing" => "GNNlib/api/messagepassing.md",
70-
"Other Operators" => "GNNlib/api/utils.md",
71-
]
73+
"Message Passing (GNNlib.jl)" => [
74+
"Message Passing" => "GNNlib/api/messagepassing.md",
75+
"Other Operators" => "GNNlib/api/utils.md",
76+
]
7277

73-
"Layers" => [
74-
"Basic layers" => "api/basic.md",
75-
"Convolutional layers" => "api/conv.md",
76-
# "Pooling layers" => "api/pool.md",
77-
"Temporal Convolutional layers" => "api/temporalconv.md",
78-
# "Hetero Convolutional layers" => "api/heteroconv.md",
79-
]
80-
],
81-
82-
# "Developer guide" => "dev.md",
78+
"Layers" => [
79+
"Basic layers" => "api/basic.md",
80+
"Convolutional layers" => "api/conv.md",
81+
# "Pooling layers" => "api/pool.md",
82+
"Temporal Convolutional layers" => "api/temporalconv.md",
83+
# "Hetero Convolutional layers" => "api/heteroconv.md",
84+
]
85+
],
86+
87+
# "Developer guide" => "dev.md",
8388
],
8489
)
8590

8691
rm(joinpath(@__DIR__, "src/GNNGraphs"), force=true, recursive=true)
8792
rm(joinpath(@__DIR__, "src/GNNlib"), force=true, recursive=true)
88-
89-
deploydocs(repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git",
90-
devbranch = "master",
91-
dirname = "GNNLux",
92-
tag_prefix="GNNLux-")
93+
94+
deploydocs(
95+
repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl",
96+
branch = "docs-gnnlux",
97+
devbranch = "master",
98+
tag_prefix="GNNLux-",
99+
)

‎GNNlib/docs/Project.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,3 @@ DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
44
GNNGraphs = "aed8fd31-079b-4b5a-b342-a13352159b8c"
55
GNNlib = "a6a84749-d869-43f8-aacc-be26a1996e48"
66
Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
7-
LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"

‎GNNlib/docs/make.jl‎

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,44 @@
1+
using Pkg
2+
Pkg.activate(@__DIR__)
3+
Pkg.develop(path=joinpath(@__DIR__, "..", "..", "GNNGraphs"))
4+
Pkg.develop(path=joinpath(@__DIR__, ".."))
5+
Pkg.instantiate()
6+
17
using Documenter
28
using GNNlib
39
using GNNGraphs
410
using DocumenterInterLinks
511

6-
712
assets=[]
813
prettyurls = get(ENV, "CI", nothing) == "true"
914
mathengine = MathJax3()
1015

1116
interlinks = InterLinks(
1217
"NNlib" => "https://fluxml.ai/NNlib.jl/stable/",
13-
"GNNGraphs" => ("https://carlolucibello.github.io/GraphNeuralNetworks.jl/GNNGraphs/", joinpath(dirname(dirname(@__DIR__)), "GNNGraphs", "docs", "build", "objects.inv")))
18+
)
1419

1520

1621
makedocs(;
17-
modules = [GNNlib],
18-
doctest = false,
19-
clean = true,
20-
plugins = [interlinks],
21-
format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
22-
sitename = "GNNlib.jl",
23-
pages = ["Home" => "index.md",
24-
"Message Passing" => "guides/messagepassing.md",
22+
modules = [GNNlib],
23+
doctest = false,
24+
clean = true,
25+
plugins = [interlinks],
26+
format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
27+
sitename = "GNNlib.jl",
28+
pages = [
29+
"Home" => "index.md",
30+
"Message Passing" => "guides/messagepassing.md",
31+
"API Reference" => [
32+
"Message Passing" => "api/messagepassing.md",
33+
"Utils" => "api/utils.md",
34+
]
35+
]
36+
)
2537

26-
"API Reference" => [
27-
28-
"Message Passing" => "api/messagepassing.md",
29-
30-
"Utils" => "api/utils.md",
31-
]
32-
33-
]
34-
)
35-
36-
deploydocs(;repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git",
37-
devbranch = "master",
38-
dirname = "GNNlib",
39-
tag_prefix="GNNlib-")
38+
deploydocs(
39+
repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl",
40+
target = "build",
41+
branch = "docs-gnnlib",
42+
devbranch = "master",
43+
tag_prefix="GNNlib-",
44+
)

0 commit comments

Comments
 (0)