reintroduce tutorials

JuliaGraphs · Jul 25, 2024 · 3c5b826 · 3c5b826
1 parent 6f7a64a
commit 3c5b826
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 441 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -4,11 +4,10 @@ using Pluto, PlutoStaticHTML # for tutorials
 using Documenter, DemoCards
 using DocumenterInterLinks
 
-# 
 
-# tutorials, tutorials_cb, tutorial_assets = makedemos("tutorials")
+tutorials, tutorials_cb, tutorial_assets = makedemos("tutorials")
 assets = []
-# isnothing(tutorial_assets) || push!(assets, tutorial_assets)
+isnothing(tutorial_assets) || push!(assets, tutorial_assets)
 
 interlinks = InterLinks(
     "NNlib" => "https://fluxml.ai/NNlib.jl/stable/",
@@ -27,14 +26,14 @@ makedocs(;
          doctest = false,
          clean = true,
          plugins = [interlinks],
-         format = Documenter.HTML(; mathengine, prettyurls, assets = assets),
+         format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
          sitename = "GraphNeuralNetworks.jl",
          pages = ["Home" => "index.md",
              "Graphs" => ["gnngraph.md", "heterograph.md", "temporalgraph.md"],
              "Message Passing" => "messagepassing.md",
              "Model Building" => "models.md",
              "Datasets" => "datasets.md",
-            #  "Tutorials" => tutorials,
+             "Tutorials" => tutorials,
              "API Reference" => [
                  "GNNGraph" => "api/gnngraph.md",
                  "Basic Layers" => "api/basic.md",
@@ -49,6 +48,6 @@ makedocs(;
              "Summer Of Code" => "gsoc.md",
          ])
 
-# tutorials_cb()
+tutorials_cb()
 
 deploydocs(repo = "github.com/CarloLucibello/GraphNeuralNetworks.jl.git")
diff --git a/docs/pluto_output/temporal_graph_classification_pluto.md b/docs/pluto_output/temporal_graph_classification_pluto.md
diff --git a/docs/pluto_output/traffic_prediction.md b/docs/pluto_output/traffic_prediction.md
diff --git a/docs/src/dev.md b/docs/src/dev.md
@@ -10,6 +10,24 @@ pkg> activate .
 
 pkg> dev ./GNNGraphs
 ```
+
+
+For generating the documentation locally instead
+```
+cd docs
+julia
+```
+```julia
+(@v1.10) pkg> activate .
+  Activating project at `~/.julia/dev/GraphNeuralNetworks/docs`
+
+(docs) pkg> dev ../ ../GNNGraphs/
+   Resolving package versions...
+  No Changes to `~/.julia/dev/GraphNeuralNetworks/docs/Project.toml`
+  No Changes to `~/.julia/dev/GraphNeuralNetworks/docs/Manifest.toml`
+
+julia> include("make.jl")
+```
 ## Benchmarking
 
 You can benchmark the effect on performance of your commits using the script `perf/perf.jl`.

diff --git a/...ls/temporal_graph_classification_pluto.jl → ...en/temporal_graph_classification_pluto.jl b/...ls/temporal_graph_classification_pluto.jl → ...en/temporal_graph_classification_pluto.jl
diff --git a/...roductory_tutorials/traffic_prediction.jl → docs/tutorials_broken/traffic_prediction.jl b/...roductory_tutorials/traffic_prediction.jl → docs/tutorials_broken/traffic_prediction.jl