public api etc

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"

docs/make.jl

@@ -1,13 +1,14 @@
 using Documenter
 using OhMyThreads
+using StableTasks
 
 const ci = get(ENV, "CI", "") == "true"
 
 @info "Generating Documenter.jl site"
 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";

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
+```

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"]
+```