Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stable documentation #551

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 2 additions & 14 deletions .github/workflows/multidocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,8 @@ jobs:
run: git config --global init.defaultBranch master

- name: Build GNNGraphs docs
run:
julia --project=GNNGraphs/docs/ -e '
run: julia --project=GNNGraphs/docs/ -e'
using Pkg;
pkg"dev ./GNNGraphs";
Pkg.instantiate();
include("GNNGraphs/docs/make.jl")'
env:
Expand All @@ -34,7 +32,6 @@ jobs:
- name: Build GNNlib docs
run: julia --project=GNNlib/docs/ -e '
using Pkg;
pkg"dev ./GNNlib ./GNNGraphs";
Pkg.instantiate();
include("GNNlib/docs/make.jl")'
env:
Expand All @@ -44,7 +41,6 @@ jobs:
- name: Build GNNLux docs
run: julia --project=GNNLux/docs/ -e '
using Pkg;
pkg"dev ./GNNLux ./GNNlib ./GNNGraphs";
Pkg.instantiate();
include("GNNLux/docs/make.jl")'
env:
Expand All @@ -54,7 +50,6 @@ jobs:
- name: Build GraphNeuralNetworks docs
run: julia --project=GraphNeuralNetworks/docs/ -e '
using Pkg;
pkg"dev ./GraphNeuralNetworks ./GNNlib ./GNNGraphs";
Pkg.instantiate();
include("GraphNeuralNetworks/docs/make.jl")'
env:
Expand All @@ -66,15 +61,8 @@ jobs:
- name: Install dependencies for multidocs
run: julia --project=docs/ -e '
using Pkg;
pkg"dev ./GraphNeuralNetworks ./GNNlib ./GNNGraphs ./GNNLux";
Pkg.instantiate();'
- name: Check if objects.inv exists for GraphNeuralNetworks
run: |
if [ -f GraphNeuralNetworks/docs/build/objects.inv ]; then
echo "GraphNeuralNetworks: objects.inv exists."
else
echo "GraphNeuralNetworks: objects.inv does not exist!" && exit 1
fi

- name: Config git
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
Expand Down
3 changes: 1 addition & 2 deletions GNNGraphs/docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ using Documenter
using DocumenterInterLinks
using GNNGraphs
using MLUtils # this is needed by setdocmeta!
import Graphs
using Graphs: induced_subgraph
using Graphs


DocMeta.setdocmeta!(GNNGraphs, :DocTestSetup, :(using GNNGraphs, MLUtils); recursive = true)
Expand Down
3 changes: 3 additions & 0 deletions GNNGraphs/docs/src/api/heterograph.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ Pages = ["gnnheterograph/query.jl"]
Private = false
```

```@docs
Graphs.has_edge(g::GNNHeteroGraph, edge_t::EType, i::Integer, j::Integer)
```
## Transform

```@autodocs
Expand Down
2 changes: 1 addition & 1 deletion GNNGraphs/src/gnnheterograph/query.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ edge_index(g::GNNHeteroGraph{<:COO_T}) = only(g.graph)[2][1:2]
get_edge_weight(g::GNNHeteroGraph{<:COO_T}, edge_t::EType) = g.graph[edge_t][3]

"""
has_edge(g::GNNHeteroGraph, edge_t, i, j)
Graphs.has_edge(g::GNNHeteroGraph, edge_t::EType, i::Integer, j::Integer)

Return `true` if there is an edge of type `edge_t` from node `i` to node `j` in `g`.

Expand Down
2 changes: 1 addition & 1 deletion GNNGraphs/src/sampling.jl
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ end


"""
induced_subgraph(graph, nodes)
Graphs.induced_subgraph(graph::GNNGraph, nodes::Vector{Int})

Generates a subgraph from the original graph using the provided `nodes`.
The function includes the nodes' neighbors and creates edges between nodes that are connected in the original graph.
Expand Down
Loading