gnngraphs

JuliaGraphs · Dec 1, 2024 · 77bc14a · 77bc14a
1 parent 70f7d83
commit 77bc14a
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 22 deletions.
diff --git a/GNNGraphs/docs/Project.toml b/GNNGraphs/docs/Project.toml
@@ -4,3 +4,6 @@ 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
@@ -4,29 +4,48 @@ using GNNGraphs
 import Graphs
 using Graphs: induced_subgraph
 
-assets=[]
-prettyurls = get(ENV, "CI", nothing) == "true"
-mathengine = MathJax3()
 
+DocMeta.setdocmeta!(GNNGraphs, :DocTestSetup, :(using GNNGraphs, MLUtils); recursive = true)
+
+mathengine = MathJax3(Dict(:loader => Dict("load" => ["[tex]/require", "[tex]/mathtools"]),
+    :tex => Dict("inlineMath" => [["\$", "\$"], ["\\(", "\\)"]],
+        "packages" => [
+            "base",
+            "ams",
+            "autoload",
+            "mathtools",
+            "require"
+        ])))
 
 makedocs(;
-         modules = [GNNGraphs],
-         doctest = false,
-         clean = true,
-         format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
-         sitename = "GNNGraphs.jl",
-         pages = ["Home" => "index.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",
-                 "TemporalSnapshotsGNNGraph" => "api/temporalgraph.md",
-                 "Samplers" => "api/samplers.md",
-              ],      
-         ]
-         )
+    modules = [GNNGraphs],
+    doctest = false, # TODO enable doctest
+    format = Documenter.HTML(; mathengine, 
+                    prettyurls = get(ENV, "CI", nothing) == "true", 
+                    assets = [],
+                    size_threshold=nothing, 
+                    size_threshold_warn=200000),sitename = "GNNGraphs.jl",
+    pages = [
+    "Home" => "index.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",
+        "TemporalSnapshotsGNNGraph" => "api/temporalgraph.md",
+        "Samplers" => "api/samplers.md",
+        ],      
+    ]
+)
 
-deploydocs(;repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git", devbranch = "master", dirname = "GNNGraphs")
+deploydocs(repo = "github.com/JuliaGraphs/GraphNeuralNetworks.jl.git", 
+         devbranch = "master", 
+         dirname = "GNNGraphs")