diff --git a/docs/Project.toml b/docs/Project.toml index 1ab3fc2..228c263 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,7 +1,9 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6" MetaGraphs = "626554b9-1ddb-594c-aa3c-2596fe9399a5" [compat] -Documenter = "0.27" -MetaGraphs = "0.8.1" +Documenter = "1" +Graphs = "1.13.3" +MetaGraphs = "0.9" diff --git a/docs/make.jl b/docs/make.jl index f01ccaf..8d3095d 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,4 +1,6 @@ -using Documenter, MetaGraphs +using Documenter +using Graphs +using MetaGraphs # index is equal to the README for the time being cp(normpath(@__FILE__, "../../README.md"), normpath(@__FILE__, "../src/index.md"); force=true) @@ -12,7 +14,7 @@ makedocs( format = Documenter.HTML(prettyurls=get(ENV, "CI", nothing) == "true"), pages = Any[ "Overview" => "index.md", - "MetaGraphs Functions" => "metagraphs.md", + "API reference" => "api.md", "License Information" => "license.md", ], ) diff --git a/docs/src/metagraphs.md b/docs/src/api.md similarity index 75% rename from docs/src/metagraphs.md rename to docs/src/api.md index 8204f15..e9319b2 100644 --- a/docs/src/metagraphs.md +++ b/docs/src/api.md @@ -1,4 +1,4 @@ -# MetaGraphs +# API reference Metadata for graphs is stored as a series of named key-value pairs, with the key being an instance of type `Symbol` and the value being any type. The following methods are available for MetaGraphs: @@ -10,4 +10,11 @@ Pages = [ "metadigraph.jl" ] Private = false +``` + +```@docs +MetaGraphs.index_available +MetaGraphs.default_index_value +add_vertex! +add_edge! ``` \ No newline at end of file