Switch to Documenter v1.0 (JuliaGraphs#322)

Tortar · Jan 3, 2024 · 34b44d0 · 34b44d0
1 parent da6f801
commit 34b44d0
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 293 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,7 @@ benchmark/.results/*
 benchmark/.tune.jld
 *.cov
 /Manifest.toml
+/docs/Manifest.toml
+/docs/src/index.md
+/docs/src/contributing.md
+/docs/src/license.md
diff --git a/docs/Manifest.toml b/docs/Manifest.toml
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -3,4 +3,4 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 
 [compat]
-Documenter = "~0.27"
+Documenter = "1"
diff --git a/docs/make.jl b/docs/make.jl
@@ -69,6 +69,7 @@ pages_files = [
     ],
     "For advanced users" => [
         "advanced/errorhandling.md",
+        "advanced/test.md",
         "advanced/experimental.md",
         "advanced/parallel.md",
         "contributing.md",

diff --git a/docs/src/advanced/test.md b/docs/src/advanced/test.md
@@ -0,0 +1,16 @@
+# Test graphs
+
+`Graphs.Test` is a module containing generic graph structures which make as few hypotheses as possible beyond the basic interface.
+It is not part of the public API and may break unexpectedly.
+
+## Index
+
+```@index
+Pages = ["test.md"]
+```
+
+## Full docs
+
+```@autodocs
+Modules = [Graphs.Test]
+```