From ccc413aed927fccaca0b2f38d0f4f77288a37a84 Mon Sep 17 00:00:00 2001
From: Carsten Bauer <crstnbr@gmail.com>
Date: Wed, 31 Jan 2024 19:52:18 +0100
Subject: [PATCH] public api etc

---
 docs/Project.toml         |  2 ++
 docs/make.jl              | 10 ++++++----
 docs/src/refs/api.md      | 23 +++++++++++++++++++++++
 docs/src/refs/internal.md | 18 ++++++++++++++++++
 4 files changed, 49 insertions(+), 4 deletions(-)
 create mode 100644 docs/src/refs/api.md
 create mode 100644 docs/src/refs/internal.md

diff --git a/docs/Project.toml b/docs/Project.toml
index 01424121..623b449b 100644
--- a/docs/Project.toml
+++ b/docs/Project.toml
@@ -1,7 +1,9 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
+StableTasks = "91464d47-22a1-43fe-8b7f-2d57ee82463f"
 
 [compat]
 Documenter = "1.2"
 DocumenterTools = "0.1"
+StableTasks = "0.1.4"
\ No newline at end of file
diff --git a/docs/make.jl b/docs/make.jl
index b8a8ea71..9a9a7209 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -1,5 +1,6 @@
 using Documenter
 using OhMyThreads
+using StableTasks
 
 const ci = get(ENV, "CI", "") == "true"
 
@@ -7,7 +8,7 @@ const ci = get(ENV, "CI", "") == "true"
 makedocs(;
     sitename = "OhMyThreads.jl",
     authors = "Carsten Bauer, Mason Protter",
-    #  modules = [OhMyThreads],
+    modules = [OhMyThreads, StableTasks],
     checkdocs = :exports,
     # doctest = ci,
     pages = [
@@ -18,9 +19,10 @@ makedocs(;
         #  "Explanations" => [
         #      "B" => "explanations/B.md",
         #  ],
-        # "References" => [
-        #     "API" => "references/api.md",
-        # ],
+        "References" => [
+            "Public API" => "refs/api.md",
+            "Internal" => "refs/internal.md",
+        ],
     ],
     repo = "https://github.com/JuliaFolds2/OhMyThreads.jl/blob/{commit}{path}#{line}",
     format = Documenter.HTML(repolink = "https://github.com/JuliaFolds2/OhMyThreads.jl";
diff --git a/docs/src/refs/api.md b/docs/src/refs/api.md
new file mode 100644
index 00000000..08ffeab9
--- /dev/null
+++ b/docs/src/refs/api.md
@@ -0,0 +1,23 @@
+# Public API
+
+## Index
+
+```@index
+Pages   = ["api.md"]
+Order   = [:function, :macro]
+```
+
+## Exported
+
+```@autodocs
+Modules = [OhMyThreads]
+Private = false
+Pages   = ["OhMyThreads.jl"]
+```
+
+## Non-Exported
+
+```@docs
+OhMyThreads.@spawn
+OhMyThreads.@spawnat
+```
\ No newline at end of file
diff --git a/docs/src/refs/internal.md b/docs/src/refs/internal.md
new file mode 100644
index 00000000..5a1f7f5f
--- /dev/null
+++ b/docs/src/refs/internal.md
@@ -0,0 +1,18 @@
+# Internal
+
+**The following is internal, i.e. not public API, and might change at any point.**
+
+## Index
+
+```@index
+Pages   = ["internal.md"]
+Order   = [:function, :macro]
+```
+
+## References
+
+```@autodocs
+Modules = [OhMyThreads, OhMyThreads.Tools]
+Public = false
+Pages   = ["OhMyThreads.jl", "tools.jl"]
+```