From 9c52145013e2ba8eb1599b4f45e869ec987d1867 Mon Sep 17 00:00:00 2001 From: Carlo Lucibello Date: Mon, 2 Dec 2024 11:56:00 +0100 Subject: [PATCH] update --- GNNGraphs/docs/make.jl | 2 +- GNNlib/docs/src/api/messagepassing.md | 1 + GNNlib/docs/src/api/utils.md | 16 ++++------------ 3 files changed, 6 insertions(+), 13 deletions(-) diff --git a/GNNGraphs/docs/make.jl b/GNNGraphs/docs/make.jl index 4b61dcd82..445fdbb4c 100644 --- a/GNNGraphs/docs/make.jl +++ b/GNNGraphs/docs/make.jl @@ -19,7 +19,7 @@ mathengine = MathJax3(Dict(:loader => Dict("load" => ["[tex]/require", "[tex]/ma makedocs(; modules = [GNNGraphs], - doctest = false, # TODO enable doctest + doctest = true, # TODO enable doctest format = Documenter.HTML(; mathengine, prettyurls = get(ENV, "CI", nothing) == "true", assets = [], diff --git a/GNNlib/docs/src/api/messagepassing.md b/GNNlib/docs/src/api/messagepassing.md index 03b50914e..e0c9f16cb 100644 --- a/GNNlib/docs/src/api/messagepassing.md +++ b/GNNlib/docs/src/api/messagepassing.md @@ -1,5 +1,6 @@ ```@meta CurrentModule = GNNlib +CollapsedDocString = true ``` # Message Passing diff --git a/GNNlib/docs/src/api/utils.md b/GNNlib/docs/src/api/utils.md index a3ae827a0..e7c79cd5b 100644 --- a/GNNlib/docs/src/api/utils.md +++ b/GNNlib/docs/src/api/utils.md @@ -1,20 +1,12 @@ ```@meta CurrentModule = GNNlib +CollpasedDocString = true ``` # Utility Functions -## Index -```@index -Order = [:type, :function] -Pages = ["utils.md"] -``` - -## Docs - - -### Graph-wise operations +## Graph-wise operations ```@docs reduce_nodes @@ -25,13 +17,13 @@ broadcast_nodes broadcast_edges ``` -### Neighborhood operations +## Neighborhood operations ```@docs softmax_edge_neighbors ``` -### NNlib's gather and scatter functions +## NNlib's gather and scatter functions Primitive functions for message passing implemented in [NNlib.jl](https://fluxml.ai/NNlib.jl/stable/reference/#Gather-and-Scatter):