Skip to content

Commit 3c5b826

Browse files
reintroduce tutorials
1 parent 6f7a64a commit 3c5b826

File tree

6 files changed

+23
-441
lines changed

6 files changed

+23
-441
lines changed

docs/make.jl

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ using Pluto, PlutoStaticHTML # for tutorials
44
using Documenter, DemoCards
55
using DocumenterInterLinks
66

7-
#
87

9-
# tutorials, tutorials_cb, tutorial_assets = makedemos("tutorials")
8+
tutorials, tutorials_cb, tutorial_assets = makedemos("tutorials")
109
assets = []
11-
# isnothing(tutorial_assets) || push!(assets, tutorial_assets)
10+
isnothing(tutorial_assets) || push!(assets, tutorial_assets)
1211

1312
interlinks = InterLinks(
1413
"NNlib" => "https://fluxml.ai/NNlib.jl/stable/",
@@ -27,14 +26,14 @@ makedocs(;
2726
doctest = false,
2827
clean = true,
2928
plugins = [interlinks],
30-
format = Documenter.HTML(; mathengine, prettyurls, assets = assets),
29+
format = Documenter.HTML(; mathengine, prettyurls, assets = assets, size_threshold=nothing),
3130
sitename = "GraphNeuralNetworks.jl",
3231
pages = ["Home" => "index.md",
3332
"Graphs" => ["gnngraph.md", "heterograph.md", "temporalgraph.md"],
3433
"Message Passing" => "messagepassing.md",
3534
"Model Building" => "models.md",
3635
"Datasets" => "datasets.md",
37-
# "Tutorials" => tutorials,
36+
"Tutorials" => tutorials,
3837
"API Reference" => [
3938
"GNNGraph" => "api/gnngraph.md",
4039
"Basic Layers" => "api/basic.md",
@@ -49,6 +48,6 @@ makedocs(;
4948
"Summer Of Code" => "gsoc.md",
5049
])
5150

52-
# tutorials_cb()
51+
tutorials_cb()
5352

5453
deploydocs(repo = "github.com/CarloLucibello/GraphNeuralNetworks.jl.git")

docs/pluto_output/temporal_graph_classification_pluto.md

Lines changed: 0 additions & 211 deletions
This file was deleted.

docs/pluto_output/traffic_prediction.md

Lines changed: 0 additions & 224 deletions
This file was deleted.

docs/src/dev.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,24 @@ pkg> activate .
1010

1111
pkg> dev ./GNNGraphs
1212
```
13+
14+
15+
For generating the documentation locally instead
16+
```
17+
cd docs
18+
julia
19+
```
20+
```julia
21+
(@v1.10) pkg> activate .
22+
Activating project at `~/.julia/dev/GraphNeuralNetworks/docs`
23+
24+
(docs) pkg> dev ../ ../GNNGraphs/
25+
Resolving package versions...
26+
No Changes to `~/.julia/dev/GraphNeuralNetworks/docs/Project.toml`
27+
No Changes to `~/.julia/dev/GraphNeuralNetworks/docs/Manifest.toml`
28+
29+
julia> include("make.jl")
30+
```
1331
## Benchmarking
1432

1533
You can benchmark the effect on performance of your commits using the script `perf/perf.jl`.

0 commit comments

Comments
 (0)