From 57cff17fe791e6befdb544922fecc0601144c513 Mon Sep 17 00:00:00 2001 From: "Viral B. Shah" Date: Mon, 14 Aug 2023 18:36:22 -0400 Subject: [PATCH] Update docs (#102) --- docs/make.jl | 5 ++--- docs/src/index.md | 11 ----------- docs/src/reference.md | 17 +++++++++++++++++ 3 files changed, 19 insertions(+), 14 deletions(-) delete mode 100644 docs/src/index.md create mode 100644 docs/src/reference.md diff --git a/docs/make.jl b/docs/make.jl index ca8a60f..d160c1c 100644 --- 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 deleted file mode 100644 index 4b371ef..0000000 --- a/docs/src/index.md +++ /dev/null @@ -1,11 +0,0 @@ -```@meta -CurrentModule = GZip -``` - -GZip ----- - -```@autodocs -Modules = [GZip] -Order = [:module, :type, :function] -``` diff --git a/docs/src/reference.md b/docs/src/reference.md new file mode 100644 index 0000000..f88d614 --- /dev/null +++ b/docs/src/reference.md @@ -0,0 +1,17 @@ +```@meta +CurrentModule = GZip +``` + +## Functions + +```@autodocs +Modules = [GZip] +Order = [:function] +``` + +## Types + +```@autodocs +Modules = [GZip] +Order = [:type] +```