From cc473a588019bcb40a9305ce18786733e57f79d2 Mon Sep 17 00:00:00 2001 From: SundaraRaman R Date: Wed, 8 Nov 2023 05:46:25 +0530 Subject: [PATCH] docs: add an index and move the docstrings to a reference page --- docs/make.jl | 3 ++- docs/src/index.md | 4 ++-- docs/src/reference.md | 5 +++++ 3 files changed, 9 insertions(+), 3 deletions(-) create mode 100644 docs/src/reference.md diff --git a/docs/make.jl b/docs/make.jl index f2220f6..167a0f4 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -4,7 +4,8 @@ makedocs( modules = [IterTools], sitename = "IterTools", pages = [ - "Docs" => "index.md", + "Home" => "index.md", + "API Reference" => "reference.md" ], doctest=false, ) diff --git a/docs/src/index.md b/docs/src/index.md index 58559b1..2157d3f 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -10,7 +10,7 @@ end Install this package with `Pkg.add("IterTools")` -# Usage -```@autodocs +## Index +```@index Modules = [IterTools] ``` diff --git a/docs/src/reference.md b/docs/src/reference.md new file mode 100644 index 0000000..ffc13b5 --- /dev/null +++ b/docs/src/reference.md @@ -0,0 +1,5 @@ +# API Reference + +```@autodocs +Modules = [IterTools] +```