You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: GraphNeuralNetworks/docs/src/dev.md
+4-13Lines changed: 4 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,22 +74,13 @@ Each PR should update the version number in the Porject.toml file of each involv
74
74
the compat bounds, e.g. GraphNeuralNetworks might require a newer version of GNNGraphs.
75
75
76
76
## Generate Documentation Locally
77
-
For generating the documentation locally
77
+
Each package has its own documentation folder, e.g. `GNNGraphs/docs`. To generate the docs locally, run the following command from the root of the repository:
78
+
78
79
```
79
-
cd docs
80
-
julia
80
+
# example for GNNGraphs
81
+
julia --project=GNNGraphs/docs GNNGraphs/docs/make.jl
81
82
```
82
-
```julia
83
-
(@v1.10) pkg> activate .
84
-
Activating project at `~/.julia/dev/GraphNeuralNetworks/docs`
85
83
86
-
(docs) pkg> dev ../../GNNGraphs/
87
-
Resolving package versions...
88
-
No Changes to `~/.julia/dev/GraphNeuralNetworks/docs/Project.toml`
89
-
No Changes to `~/.julia/dev/GraphNeuralNetworks/docs/Manifest.toml`
90
-
91
-
julia>include("make.jl")
92
-
```
93
84
## Benchmarking
94
85
95
86
You can benchmark the effect on performance of your commits using the script `perf/perf.jl`.
0 commit comments