Improve on docs

Project.toml

@@ -1,7 +1,7 @@
 name = "Batsrus"
 uuid = "e74ebddf-6ac1-4047-a0e5-c32c99e57753"
 authors = ["Hongyang Zhou <[email protected]>"]
-version = "0.2.5"
+version = "0.2.6"
 
 [deps]
 FortranFiles = "c58ffaec-ab22-586d-bfc5-781a99fd0b10"

docs/make.jl

@@ -1,16 +1,23 @@
-using Documenter, Batsrus
+using Batsrus, Documenter
 
-#push!(LOAD_PATH,"../src/")
-
-makedocs(
-    sitename="Batsrus",
-    format = Documenter.HTML(
-        prettyurls = get(ENV, "CI", nothing) == "true"
-    )
+makedocs(;
+    modules=[Batsrus],
+    authors="Hongyang Zhou <[email protected]>",
+    repo="https://github.com/henry2004y/Batsrus.jl/blob/{commit}{path}#L{line}",
+    sitename="Batsrus.jl",
+    format=Documenter.HTML(;
+        prettyurls=get(ENV, "CI", "false") == "true",
+        canonical="https://henry2004y.github.io/Batsrus.jl",
+        assets=String[],
+    ),
+    pages=[
+        "Home" => "index.md",
+        "Example" => "examples.md",
+        "Internal" => "internal.md",
+        "Log" => "log.md",
+    ],
 )
 
-deploydocs(
-    repo = "github.com/henry2004y/Batsrus.jl.git",
-    target = "build",
-    branch = "gh-pages"
+deploydocs(;
+    repo="github.com/henry2004y/Batsrus.jl",
 )

docs/src/index.md

@@ -1,4 +1,4 @@
-# Batsrus.jl Documentation
+# Batsrus.jl
 
 ## Overview
 

docs/src/man/internal.md

@@ -0,0 +1,17 @@
+# APIs
+
+## Public types in module `Batsrus`:
+
+```@autodocs
+Modules = [Batsrus]
+Private = false
+Order = [:type]
+```
+
+## Functions exported from `Batsrus`:
+
+```@autodocs
+Modules = [Batsrus]
+Private = false
+Order = [:function]
+```