move around docs

Author: CarloLucibello

GNNGraphs/docs/make.jl

@@ -16,8 +16,10 @@ makedocs(;
          format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
          sitename = "GNNGraphs.jl",
          pages = ["Home" => "index.md",
-            "Graphs" => ["gnngraph.md", "heterograph.md", "temporalgraph.md"],
-            "Datasets" => "datasets.md",
+            "Guides" => [
+               "Graphs" => ["guides/gnngraph.md", "guides/heterograph.md", "guides/temporalgraph.md"],
+               "Datasets" => "guides/datasets.md",
+            ],
             "API Reference" => [
                  "GNNGraph" => "api/gnngraph.md",
                  "GNNHeteroGraph" => "api/heterograph.md",

GNNGraphs/docs/src/datasets.md renamed to GNNGraphs/docs/src/guides/datasets.md

@@ -21,7 +21,7 @@ makedocs(;
          format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
          sitename = "GNNlib.jl",
          pages = ["Home" => "index.md",
-            "Message Passing" => "messagepassing.md",
+            "Message Passing" => "guides/messagepassing.md",
 
             "API Reference" => [
 

GNNGraphs/docs/src/gnngraph.md renamed to GNNGraphs/docs/src/guides/gnngraph.md

@@ -14,28 +14,44 @@ interlinks = InterLinks(
 
    )
 
+# Copy the guides from GNNGraphs and GNNlib
+dest_guides_dir = joinpath(@__DIR__, "src/guides")
+gnngraphs_guides_dir = joinpath(@__DIR__, "../../GNNGraphs/docs/src/guides")
+gnnlib_guides_dir = joinpath(@__DIR__, "../../GNNlib/docs/src/guides") 
+for file in readdir(gnngraphs_guides_dir)
+    cp(joinpath(gnngraphs_guides_dir, file), joinpath(dest_guides_dir, file))
+end
+for file in readdir(gnnlib_guides_dir)
+    cp(joinpath(gnnlib_guides_dir, file), joinpath(dest_guides_dir, file))
+end
+
 makedocs(;
-         modules = [GraphNeuralNetworks],
-         doctest = false,
-         clean = true,
-         plugins = [interlinks],
-         format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
-         sitename = "GraphNeuralNetworks.jl",
-         pages = [
-            "Home" => "index.md",
-            "Guides" => [
-                "Models" => "models.md",
-            ],
-            "API Reference" => [
-                  "Basic" => "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",
-            
-         ],
-         )
+    modules = [GraphNeuralNetworks],
+    doctest = false,
+    clean = true,
+    plugins = [interlinks],
+    format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
+    sitename = "GraphNeuralNetworks.jl",
+    pages = [
+    
+    "Home" => "index.md",
+    
+    "Guides" => [
+        "Graphs" => ["guides/gnngraph.md", "guides/heterograph.md", "guides/temporalgraph.md"],
+        "Message Passing" => "guides/messagepassing.md",
+        "Models" => "guides/models.md",
+        "Datasets" => "guides/datasets.md",
+    ],
+
+    "API Reference" => [
+            "Basic" => "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",
+    ],
+)
 
 deploydocs(;repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git", devbranch = "master", dirname= "GraphNeuralNetworks")

GNNGraphs/docs/src/heterograph.md renamed to GNNGraphs/docs/src/guides/heterograph.md

@@ -0,0 +1,10 @@
+# Datasets
+
+GNNGraphs.jl doesn't come with its own datasets, but leverages those available in the Julia (and non-Julia) ecosystem. In particular, the [examples in the GraphNeuralNetworks.jl repository](https://github.com/JuliaGraphs/GraphNeuralNetworks.jl/tree/master/examples) make use of the [MLDatasets.jl](https://github.com/JuliaML/MLDatasets.jl) package. There you will find common graph datasets such as Cora, PubMed, Citeseer, TUDataset and [many others](https://juliaml.github.io/MLDatasets.jl/dev/datasets/graphs/).
+For graphs with static structures and temporal features, datasets such as METRLA, PEMSBAY, ChickenPox, and WindMillEnergy are available. For graphs featuring both temporal structures and temporal features, the TemporalBrains dataset is suitable.
+
+GraphNeuralNetworks.jl provides the [`mldataset2gnngraph`](@ref) method for interfacing with MLDatasets.jl.
+
+```@docs
+mldataset2gnngraph
+```