Update docs (#102)

JuliaIO · Aug 14, 2023 · 57cff17 · 57cff17
1 parent 080590e
commit 57cff17
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 14 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,15 +1,14 @@
 using GZip
 using Documenter
 
-push!(LOAD_PATH,"../src/")
-
 makedocs(
     sitename = "GZip.jl",
     modules = [GZip],
     authors = "JuliaIO and contributors",
     format = Documenter.HTML(; assets = String[]),
     pages = [
-        "Home" => "index.md",
+        "GZip" => "index.md",
+        "Reference" => "reference.md",
     ],
 )
 

diff --git a/docs/src/index.md b/docs/src/index.md
diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -0,0 +1,17 @@
+```@meta
+CurrentModule = GZip
+```
+
+## Functions
+
+```@autodocs
+Modules = [GZip]
+Order   = [:function]
+```
+
+## Types
+
+```@autodocs
+Modules = [GZip]
+Order   = [:type]
+```