update docs

Co-Authored-By: Pietro Monticone <[email protected]>
Co-Authored-By: Claudio Moroni <[email protected]>

Author: 3 people

docs/make.jl

@@ -26,7 +26,7 @@ makedocs(;
         canonical="https://juliagraphs.org/MultilayerGraphs.jl",
         assets=String[],
     ),
-    pages=["Home" => "index.md", "API" => "API.md"],
+    pages=["Home" => "index.md", "API" => "API_organized.md"],
     clean=false,
 )
 

docs/src/API.md renamed to docs/src/API_autodocs.md

@@ -1,6 +1,6 @@
 # API
 
-This page provides a list of exported methods organized by topic and audience. Methods that act on vertices, edges, and layers are grouped together. Some methods are intended for developers who want to use the `Graphs.jl` library as part of their code, while others are meant for end-users.
+This page provides a list of exported methods organized by topic and audience. Methods that act on vertices, edges, and layers are grouped together. Some methods are intended for developers who want to use the `Graphs.jl` library as part of their code, while others are meant for end-users. hello
 
 ## End-User
 
@@ -252,8 +252,8 @@ has_edge(mg::AbstractMultilayerGraph, edge::MultilayerEdge)
 has_edge( subgraph::AbstractMultilayerGraph, s::MultilayerVertex, d::MultilayerVertex)
 ne(mg::AbstractMultilayerGraph)
 <!-- edges(mg::AbstractMultilayerUGraph) -->
-<!-- edges(mg::M) where {T,U,M<:AbstractMultilayerUGraph{T,U}}
-edges(mg::M) where {T,U,M<:AbstractMultilayerGraph{T,U}; IsDirected{M}} -->
+<!-- edges(mg::M) where {T,U,M<:AbstractMultilayerUGraph{T,U}} -->
+edges(mg::M) where {T,U,M<:AbstractMultilayerGraph{T,U}; IsDirected{M}}
 edges
 add_edge!(mg::M, src::V, dst::V; weight::Union{Nothing, U} = one(U), metadata::Union{Tuple,NamedTuple} = NamedTuple() ) where {T,U, M <: AbstractMultilayerGraph{T,U}, V <: MultilayerVertex}
 add_edge!(mg::M, me::E) where {T,U, M <: AbstractMultilayerGraph{T,U}, E <: MultilayerEdge{ <: Union{U,Nothing}}}

docs/src/API_organized.md

@@ -6,7 +6,7 @@ An abstract type representing a node.
 abstract type AbstractNode end
 
 """
-    struct Node <: AbstractNode
+    Node <: AbstractNode
 
 A custom concrete type representing a node of a multilayer graph.
 """

src/node.jl

@@ -33,42 +33,42 @@ struct MultilayerVertex{S} <: AbstractMultilayerVertex{S}
     end
 end
 
-"""
+#= """
     MultilayerVertex(node::Node, layer::Symbol)
 
 Return `MultilayerVertex(node, layer, NamedTuple())`
-"""
+""" =#
 MultilayerVertex(node::Node, layer::Symbol) = MultilayerVertex(node, layer, NamedTuple())
 
-"""
+#= """
     MultilayerVertex(node::Node, not::Nothing)
 
 Return `MultilayerVertex(node, nothing, NamedTuple())`.
-"""
+""" =#
 MultilayerVertex(node::Node, not::Nothing) = MultilayerVertex(node, nothing, NamedTuple())
 
-"""
+#= """
     MultilayerVertex(node::Node, metadata::Union{Tuple,NamedTuple})
 
 Return `MultilayerVertex(node, nothing, metadata)`.
-"""
+""" =#
 function MultilayerVertex(node::Node, metadata::Union{Tuple,NamedTuple})
     return MultilayerVertex(node, nothing, metadata)
 end
 
-"""
+#= """
     MultilayerVertex(node::Node)
 
 Return `MultilayerVertex(node, nothing, NamedTuple())`.
-"""
+""" =#
 MultilayerVertex(node::Node) = MultilayerVertex(node, nothing, NamedTuple())
 
 # Shorter alias for MultilayerVertex
-"""
+#= """
     MV
 
 Alias for `MultilayerVertex`
-"""
+""" =#
 const MV = MultilayerVertex
 
 # Base overrides