Add barebone docs

JuliaPsychometricsBazaar · Nov 24, 2023 · ba081ed · ba081ed
1 parent c7f8881
commit ba081ed
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 /Manifest.toml
 /test/test-results.xml
+/docs/build/
+/docs/Manifest.toml
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,5 @@
+[deps]
+AdaptiveTestPlots = "d194c7c1-4081-4169-ba52-101f65b44e42"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+FittedItemBanks = "3f797b09-34e4-41d7-acf6-3302ae3248a5"
+LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,24 @@
+using AdaptiveTestPlots
+using Documenter
+using Documenter.Remotes: GitHub
+
+format = Documenter.HTML(
+    prettyurls=get(ENV, "CI", "false") == "true",
+    canonical="https://JuliaPsychometricsBazaar.github.io/AdaptiveTestPlots.jl",
+)
+
+makedocs(;
+    modules=[AdaptiveTestPlots],
+    authors="Frankie Robertson",
+    repo = GitHub("JuliaPsychometricsBazaar", "AdaptiveTestPlots.jl"),
+    sitename="AdaptiveTestPlots.jl",
+    format=format,
+    pages=[
+        "Home" => "index.md",
+    ],
+)
+
+deploydocs(;
+    repo="github.com/JuliaPsychometricsBazaar/AdaptiveTestPlots.jl",
+    devbranch="main",
+)
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,12 @@
+# AdaptiveTestPlots.jl
+
+This is a package for plotting recordings of CATs (Computerised Adaptive Tests).
+
+```@meta
+CurrentModule = AdaptiveTestPlots
+```
+
+## Index
+
+```@index
+```