Skip to content

Update Documenter requirement from 0.27 to 0.27, 1.16 in /docs #56

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.

Sign up for GitHub

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

Merged
simsurace merged 1 commit into from
Jan 29, 2026
Merged

Update Documenter requirement from 0.27 to 0.27, 1.16 in /docs #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
6 changes: 4 additions & 2 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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",
],
)
Expand Down
9 changes: 8 additions & 1 deletion docs/src/metagraphs.md → docs/src/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -10,4 +10,11 @@ Pages = [
"metadigraph.jl"
]
Private = false
```

```@docs
MetaGraphs.index_available
MetaGraphs.default_index_value
add_vertex!
add_edge!
```
Loading