From 283783174f3ce0476300f1a347c355b7785c7ccc Mon Sep 17 00:00:00 2001
From: Juan Ignacio Polanco <juan-ignacio.polanco@cnrs.fr>
Date: Thu, 4 Jan 2024 16:30:50 +0100
Subject: [PATCH] Add some docs

---
 docs/make.jl    |  6 ++++++
 docs/src/API.md | 27 +++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 docs/src/API.md

diff --git a/docs/make.jl b/docs/make.jl
index ac1374c..0234f7f 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -6,6 +6,12 @@ makedocs(;
     format = Documenter.HTML(
         prettyurls = get(ENV, "CI", nothing) == "true",
     ),
+    modules = [NonuniformFFTs],
+    pages = [
+        "index.md",
+        "API.md",
+    ],
+    warnonly = [:missing_docs],  # TODO fix this?
 )
 
 deploydocs(
diff --git a/docs/src/API.md b/docs/src/API.md
new file mode 100644
index 0000000..c191331
--- /dev/null
+++ b/docs/src/API.md
@@ -0,0 +1,27 @@
+# API
+
+```@meta
+CurrentModule = NonuniformFFTs
+```
+
+## Creating plans
+
+```@docs
+PlanNUFFT
+```
+
+## Setting non-uniform points
+
+## Executing plans
+
+## Other functions
+
+```@docs
+size(::PlanNUFFT)
+```
+
+## Index
+
+```@index
+Pages = ["NUFFT.md"]
+```