Add documentation for external libraries.

bakpakin · bakpakin · commit b199b6b12b25 · 2022-10-13T19:45:55.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,4 @@ out
 site
 janet_modules
 build
-jpm/
+/jpm/
diff --git a/Makefile b/Makefile
@@ -24,6 +24,7 @@ build/bin/janet: janet/janet.c janet/janet.h janet/shell.c
 	cd jpm && git pull origin master || true
 	@cd jpm && $(JSETTINGS) PREFIX=$(CWD)/build/ $(CWD)/build/bin/janet bootstrap.janet
 	@$(JSETTINGS) build/bin/jpm install mendoza
+	@$(JSETTINGS) build/bin/jpm install spork
 
 .PHONY: wasm
 wasm: static/js/janet.js
diff --git a/content/api/gen-docs.janet b/content/api/gen-docs.janet
@@ -71,13 +71,15 @@
 
                {:tag "a" "href" (string "https://janetdocs.com/" (jdoc-escape key)) :content "Community Examples"}]}))
 
-(def- all-entries 
-  (sort (pairs (table/getproto (fiber/getenv (fiber/current))))))
+(defn- all-entries 
+  [&opt env]
+  (default env root-env)
+  (sort (pairs env)))
 
 (defn- get-from-prefix
   "Get all bindings that start with a prefix."
-  [prefix]
-  (seq [x :in all-entries
+  [prefix &opt env]
+  (seq [x :in (all-entries env)
         :let [[k entry] x]
         :when (symbol? k)
         :when (get entry :doc)
@@ -87,8 +89,8 @@
 
 (defn- get-from-peg
   "Get all bindings that start with a prefix."
-  [peg]
-  (seq [x :in all-entries
+  [peg &opt env]
+  (seq [x :in (all-entries env)
         :let [[k entry] x]
         :when (symbol? k)
         :when (get entry :doc)
@@ -98,8 +100,8 @@
 
 (defn gen-peg
   "Generate the document for all of the core api whose name matches the peg."
-  [peg]
-  (def entries (get-from-peg peg))
+  [peg &opt env]
+  (def entries (get-from-peg peg env))
   (def index
     (seq [[k entry] :in entries]
          [{:tag "a" "href" (string "#" k) :content k} " "]))
@@ -110,8 +112,13 @@
 
 (defn gen-prefix
   "Generate the documentation for some subset of the core api."
+  [prefix &opt env]
+  (gen-peg (peg/compile prefix) env))
+
+(defn gen-prefix-current
+  "Generate the documentation for some module in that has been loaded"
   [prefix]
-  (gen-peg (peg/compile prefix)))
+  (gen-peg (peg/compile prefix) (curenv)))
 
 (defn gen
   "Generate all bindings."
diff --git a/content/api/jpm/cc.mdz b/content/api/jpm/cc.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/cc :export true)
+
+{:title "C Compiler"
+ :nav-title "cc"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[cc/]
diff --git a/content/api/jpm/cgen.mdz b/content/api/jpm/cgen.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/cgen :export true)
+
+{:title "C Source Generation"
+ :nav-title "cgen"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[cgen/]
diff --git a/content/api/jpm/cli.mdz b/content/api/jpm/cli.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/cli :export true)
+
+{:title "Command Line Interface"
+ :nav-title "cli"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[cli/]
diff --git a/content/api/jpm/commands.mdz b/content/api/jpm/commands.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/commands :export true)
+
+{:title "Commands"
+ :nav-title "commands"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[commands/]
diff --git a/content/api/jpm/config.mdz b/content/api/jpm/config.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/config :export true)
+
+{:title "Config"
+ :nav-title "config"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[config/]
diff --git a/content/api/jpm/dagbuild.mdz b/content/api/jpm/dagbuild.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/dagbuild :export true)
+
+{:title "DAG Build"
+ :nav-title "dagbuild"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[dagbuild/]
diff --git a/content/api/jpm/index.mdz b/content/api/jpm/index.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm :export true)
+
+{:title "JPM"
+ :nav-title "jpm"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[jpm/]
diff --git a/content/api/jpm/make-config.mdz b/content/api/jpm/make-config.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/make-config :export true)
+
+{:title "Configuration Generation"
+ :nav-title "make-config"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[make-config/]
diff --git a/content/api/jpm/pm.mdz b/content/api/jpm/pm.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/pm :export true)
+
+{:title "Project Management"
+ :nav-title "pm"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[pm/]
diff --git a/content/api/jpm/rules.mdz b/content/api/jpm/rules.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/rules :export true)
+
+{:title "Build Rules"
+ :nav-title "rules"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[rules/]
diff --git a/content/api/jpm/scaffold.mdz b/content/api/jpm/scaffold.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/scaffold :export true)
+
+{:title "Project Scaffolding"
+ :nav-title "scaffold"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[scaffold/]
diff --git a/content/api/jpm/shutil.mdz b/content/api/jpm/shutil.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import jpm/shutil :export true)
+
+{:title "Shell Utilities"
+ :nav-title "shutil"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[shutil/]
diff --git a/content/api/spork/argparse.mdz b/content/api/spork/argparse.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/argparse :export true)
+
+{:title "Argument Parsing"
+ :nav-title "argparse"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[spork/]
diff --git a/content/api/spork/base64.mdz b/content/api/spork/base64.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/base64 :export true)
+
+{:title "Base64"
+ :nav-title "base64"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[base64/]
diff --git a/content/api/spork/cron.mdz b/content/api/spork/cron.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/cron :export true)
+
+{:title "Cron"
+ :nav-title "cron"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[cron/]
diff --git a/content/api/spork/ev-utils.mdz b/content/api/spork/ev-utils.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/ev-utils :export true)
+
+{:title "EV Utilities"
+ :nav-title "ev-utils"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[ev-utils/]
diff --git a/content/api/spork/fmt.mdz b/content/api/spork/fmt.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/fmt :export true)
+
+{:title "Format"
+ :nav-title "fmt"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[fmt/]
diff --git a/content/api/spork/generators.mdz b/content/api/spork/generators.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/generators :export true)
+
+{:title "Generators"
+ :nav-title "generators"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[generators/]
diff --git a/content/api/spork/getline.mdz b/content/api/spork/getline.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/getline :export true)
+
+{:title "Getline"
+ :nav-title "getline"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[getline/]
diff --git a/content/api/spork/http.mdz b/content/api/spork/http.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/http :export true)
+
+{:title "HTTP"
+ :nav-title "http"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[http/]
diff --git a/content/api/spork/httpf.mdz b/content/api/spork/httpf.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/httpf :export true)
+
+{:title "HTTP Framework"
+ :nav-title "httpf"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[httpf/]
diff --git a/content/api/spork/index.mdz b/content/api/spork/index.mdz
@@ -0,0 +1,20 @@
+(import ../gen-docs :as gen-docs)
+(import spork :export true)
+
+{:title "Spork"
+ :nav-title "spork"
+ :template "docpage.html"}
+---
+
+While not part of Janet's core library, Spork is an official "contributor" library as well as a collection
+of various useful utilties for Janet.
+
+Spork can be installed with
+
+@codeblock```
+jpm install spork
+```
+
+## Index
+
+@gen-docs/gen-prefix-current[spork/]
diff --git a/content/api/spork/json.mdz b/content/api/spork/json.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/json :export true)
+
+{:title "JSON"
+ :nav-title "json"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[json/]
diff --git a/content/api/spork/misc.mdz b/content/api/spork/misc.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/misc :export true)
+
+{:title "Miscellaneous Functions"
+ :nav-title "misc"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[misc/]
diff --git a/content/api/spork/msg.mdz b/content/api/spork/msg.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/msg :export true)
+
+{:title "Simple Messaging Protocol"
+ :nav-title "msg"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[msg/]
diff --git a/content/api/spork/netrepl.mdz b/content/api/spork/netrepl.mdz
@@ -0,0 +1,11 @@
+(import ../gen-docs :as gen-docs)
+(import spork/netrepl :export true)
+
+{:title "NetREPL"
+ :nav-title "netrepl"
+ :template "docpage.html"}
+---
+
+## Index
+
+@gen-docs/gen-prefix-current[netrepl/]
diff --git a/content/api/spork/path.mdz b/content/api/spork/path.mdz
diff --git a/content/api/spork/rawterm.mdz b/content/api/spork/rawterm.mdz
diff --git a/content/api/spork/regex.mdz b/content/api/spork/regex.mdz
diff --git a/content/api/spork/rpc.mdz b/content/api/spork/rpc.mdz
diff --git a/content/api/spork/schema.mdz b/content/api/spork/schema.mdz
diff --git a/content/api/spork/sh.mdz b/content/api/spork/sh.mdz
diff --git a/content/api/spork/tarray.mdz b/content/api/spork/tarray.mdz
diff --git a/content/api/spork/test.mdz b/content/api/spork/test.mdz

-Original file line number
+Diff line change
 site
 janet_modules
 build
 -jpm/
 +/jpm/