try new approach for building and deploying docs

JuliaGraphs · Dec 8, 2024 · 4d711e8 · 4d711e8
1 parent 7bd58c6
commit 4d711e8
Show file tree

Hide file tree

Showing 8 changed files with 195 additions and 228 deletions.
diff --git a/GNNGraphs/docs/Project.toml b/GNNGraphs/docs/Project.toml
@@ -3,7 +3,6 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 GNNGraphs = "aed8fd31-079b-4b5a-b342-a13352159b8c"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
-LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 MLDatasets = "eb30cadb-4394-5ae3-aed4-317e484a6458"
 MLUtils = "f1d291b0-491e-4a28-83b9-f70985020b54"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
diff --git a/GNNGraphs/docs/make.jl b/GNNGraphs/docs/make.jl
@@ -1,3 +1,8 @@
+using Pkg
+Pkg.activate(@__DIR__)
+Pkg.develop(path=joinpath(@__DIR__, ".."))
+Pkg.instantiate()
+
 using Documenter
 using DocumenterInterLinks
 using GNNGraphs
@@ -27,25 +32,28 @@ makedocs(;
                     size_threshold=nothing, 
                     size_threshold_warn=200000),sitename = "GNNGraphs.jl",
     pages = [
-    "Home" => "index.md",
-
-    "Guides" => [
-        "Graphs" => "guides/gnngraph.md", 
-        "Heterogeneous Graphs" => "guides/heterograph.md",
-        "Temporal Graphs" => "guides/temporalgraph.md",
-        "Datasets" => "guides/datasets.md",
-    ],
+        "Home" => "index.md",
+        
+        "Guides" => [
+            "Graphs" => "guides/gnngraph.md", 
+            "Heterogeneous Graphs" => "guides/heterograph.md",
+            "Temporal Graphs" => "guides/temporalgraph.md",
+            "Datasets" => "guides/datasets.md",
+        ],
 
-    "API Reference" => [
-        "GNNGraph" => "api/gnngraph.md",
-        "GNNHeteroGraph" => "api/heterograph.md",
-        "TemporalSnapshotsGNNGraph" => "api/temporalgraph.md",
-        "Samplers" => "api/samplers.md",
+        "API Reference" => [
+            "GNNGraph" => "api/gnngraph.md",
+            "GNNHeteroGraph" => "api/heterograph.md",
+            "TemporalSnapshotsGNNGraph" => "api/temporalgraph.md",
+            "Samplers" => "api/samplers.md",
         ],      
     ]
 )
-
-deploydocs(repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git", 
-         devbranch = "master", 
-         dirname = "GNNGraphs",
-         tag_prefix="GNNGraphs-")
+
+deploydocs(
+    repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl", 
+    target = "build",
+    branch = "docs-gnngraphs",
+    devbranch = "master", 
+    tag_prefix="GNNGraphs-",
+)
diff --git a/GNNLux/docs/make.jl b/GNNLux/docs/make.jl
@@ -1,3 +1,10 @@
+using Pkg
+Pkg.activate(@__DIR__)
+Pkg.develop(path=joinpath(@__DIR__, "..", "..", "GNNGraphs"))
+Pkg.develop(path=joinpath(@__DIR__, "..", "..", "GNNlib"))
+Pkg.develop(path=joinpath(@__DIR__, ".."))
+Pkg.instantiate()
+
 using Documenter
 using GNNLux
 using Lux, GNNGraphs, GNNlib, Graphs
@@ -18,9 +25,7 @@ mathengine = MathJax3(Dict(:loader => Dict("load" => ["[tex]/require", "[tex]/ma
 
 interlinks = InterLinks(
     "NNlib" => "https://fluxml.ai/NNlib.jl/stable/",
-    # "GNNGraphs" => ("https://carlolucibello.github.io/GraphNeuralNetworks.jl/GNNGraphs/",  joinpath(dirname(dirname(@__DIR__)), "GNNGraphs", "docs", "build", "objects.inv")),
-    # "GNNlib" => ("https://carlolucibello.github.io/GraphNeuralNetworks.jl/GNNlib/",  joinpath(dirname(dirname(@__DIR__)), "GNNlib", "docs", "build", "objects.inv"))
-   )
+)
 
 # Copy the docs from GNNGraphs and GNNlib. Will be removed at the end of the script
 cp(joinpath(@__DIR__, "../../GNNGraphs/docs/src"),
@@ -29,64 +34,66 @@ cp(joinpath(@__DIR__, "../../GNNlib/docs/src"),
    joinpath(@__DIR__, "src/GNNlib"), force=true)
 
 makedocs(;
-         modules = [GNNLux, GNNGraphs, GNNlib],
-         doctest = false, # TODO: enable doctest
-         plugins = [interlinks],
-         format = Documenter.HTML(; mathengine, 
-                            prettyurls = get(ENV, "CI", nothing) == "true", 
-                            assets = [],
-                            size_threshold=nothing, 
-                            size_threshold_warn=2000000),
-         sitename = "GNNLux.jl",
-         pages = [
+    modules = [GNNLux, GNNGraphs, GNNlib],
+    doctest = false, # TODO: enable doctest
+    plugins = [interlinks],
+    format = Documenter.HTML(; mathengine, 
+                    prettyurls = get(ENV, "CI", nothing) == "true", 
+                    assets = [],
+                    size_threshold=nothing, 
+                    size_threshold_warn=2000000),
+    sitename = "GNNLux.jl",
+    pages = [
+
+        "Home" => "index.md",
 
-         "Home" => "index.md",
-
-    "Guides" => [
-        "Graphs" => "GNNGraphs/guides/gnngraph.md",
-        "Message Passing" => "GNNlib/guides/messagepassing.md",
-        "Models" => "guides/models.md",
-        "Datasets" => "GNNGraphs/guides/datasets.md",
-        "Heterogeneous Graphs" => "GNNGraphs/guides/heterograph.md",
-        "Temporal Graphs" => "GNNGraphs/guides/temporalgraph.md",
-    ],
+        "Guides" => [
+            "Graphs" => "GNNGraphs/guides/gnngraph.md",
+            "Message Passing" => "GNNlib/guides/messagepassing.md",
+            "Models" => "guides/models.md",
+            "Datasets" => "GNNGraphs/guides/datasets.md",
+            "Heterogeneous Graphs" => "GNNGraphs/guides/heterograph.md",
+            "Temporal Graphs" => "GNNGraphs/guides/temporalgraph.md",
+        ],
 
-    "Tutorials" => [
-        "Introductory tutorials" => [
-            "Hands on" => "tutorials/gnn_intro.md",
+        "Tutorials" => [
+            "Introductory tutorials" => [
+                "Hands on" => "tutorials/gnn_intro.md",
+                ],
             ],
-        ],
 
-    "API Reference" => [
-        "Graphs (GNNGraphs.jl)" => [
-            "GNNGraph" => "GNNGraphs/api/gnngraph.md",
-            "GNNHeteroGraph" => "GNNGraphs/api/heterograph.md",
-            "TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
-            "Samplers" => "GNNGraphs/api/samplers.md",
-        ]
+        "API Reference" => [
+            "Graphs (GNNGraphs.jl)" => [
+                "GNNGraph" => "GNNGraphs/api/gnngraph.md",
+                "GNNHeteroGraph" => "GNNGraphs/api/heterograph.md",
+                "TemporalSnapshotsGNNGraph" => "GNNGraphs/api/temporalgraph.md",
+                "Samplers" => "GNNGraphs/api/samplers.md",
+            ]
 
-        "Message Passing (GNNlib.jl)" => [
-            "Message Passing" => "GNNlib/api/messagepassing.md",
-            "Other Operators" => "GNNlib/api/utils.md",
-        ]
+            "Message Passing (GNNlib.jl)" => [
+                "Message Passing" => "GNNlib/api/messagepassing.md",
+                "Other Operators" => "GNNlib/api/utils.md",
+            ]
 
-        "Layers" => [
-            "Basic layers" => "api/basic.md",
-            "Convolutional layers" => "api/conv.md",
-            # "Pooling layers" => "api/pool.md",
-            "Temporal Convolutional layers" => "api/temporalconv.md",
-            # "Hetero Convolutional layers" => "api/heteroconv.md",
-        ]
-    ],
-
-    # "Developer guide" => "dev.md",
+            "Layers" => [
+                "Basic layers" => "api/basic.md",
+                "Convolutional layers" => "api/conv.md",
+                # "Pooling layers" => "api/pool.md",
+                "Temporal Convolutional layers" => "api/temporalconv.md",
+                # "Hetero Convolutional layers" => "api/heteroconv.md",
+            ]
+        ],
+        
+        # "Developer guide" => "dev.md",
     ],
 )
 
 rm(joinpath(@__DIR__, "src/GNNGraphs"), force=true, recursive=true)
 rm(joinpath(@__DIR__, "src/GNNlib"), force=true, recursive=true)
-
-deploydocs(repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git", 
-        devbranch = "master", 
-        dirname = "GNNLux",
-        tag_prefix="GNNLux-")
+
+deploydocs(
+    repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl", 
+    branch = "docs-gnnlux",
+    devbranch = "master", 
+    tag_prefix="GNNLux-",
+)
diff --git a/GNNlib/docs/Project.toml b/GNNlib/docs/Project.toml
@@ -4,4 +4,3 @@ DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
 GNNGraphs = "aed8fd31-079b-4b5a-b342-a13352159b8c"
 GNNlib = "a6a84749-d869-43f8-aacc-be26a1996e48"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
-LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
diff --git a/GNNlib/docs/make.jl b/GNNlib/docs/make.jl
@@ -1,39 +1,44 @@
+using Pkg
+Pkg.activate(@__DIR__)
+Pkg.develop(path=joinpath(@__DIR__, "..", "..", "GNNGraphs"))
+Pkg.develop(path=joinpath(@__DIR__, ".."))
+Pkg.instantiate()
+
 using Documenter
 using GNNlib
 using GNNGraphs
 using DocumenterInterLinks
 
-
 assets=[]
 prettyurls = get(ENV, "CI", nothing) == "true"
 mathengine = MathJax3()
 
 interlinks = InterLinks(
     "NNlib" => "https://fluxml.ai/NNlib.jl/stable/",
-    "GNNGraphs" => ("https://carlolucibello.github.io/GraphNeuralNetworks.jl/GNNGraphs/",  joinpath(dirname(dirname(@__DIR__)), "GNNGraphs", "docs", "build", "objects.inv")))
+)
 
 
 makedocs(;
-         modules = [GNNlib],
-         doctest = false,
-         clean = true,
-         plugins = [interlinks],
-         format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
-         sitename = "GNNlib.jl",
-         pages = ["Home" => "index.md",
-            "Message Passing" => "guides/messagepassing.md",
+    modules = [GNNlib],
+    doctest = false,
+    clean = true,
+    plugins = [interlinks],
+    format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
+    sitename = "GNNlib.jl",
+    pages = [
+        "Home" => "index.md",
+        "Message Passing" => "guides/messagepassing.md",
+        "API Reference" => [
+            "Message Passing" => "api/messagepassing.md",
+            "Utils" => "api/utils.md",
+        ]
+    ]
+)
 
-            "API Reference" => [
-
-                  "Message Passing" => "api/messagepassing.md",
-
-                "Utils" => "api/utils.md",
-              ]
-
-         ]
-         )
-
-deploydocs(;repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git", 
-          devbranch = "master", 
-          dirname = "GNNlib",
-          tag_prefix="GNNlib-")
+deploydocs(
+    repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl", 
+    target = "build",
+    branch = "docs-gnnlib",
+    devbranch = "master", 
+    tag_prefix="GNNlib-",
+)