aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorCaleb Figgers <cdfiggers@gmail.com>2024-09-01 14:31:44 -0500
committerCaleb Figgers <cdfiggers@gmail.com>2024-09-01 14:31:44 -0500
commitf06fd107ff567393b30e7699bf47df33a0509ec1 (patch)
tree0b1c84f10e28f61dc39081094836ef264384641a /doc
parentTweaks to heading levels (diff)
Display all API References with module prefix
Diffstat (limited to 'doc')
-rw-r--r--doc/api/argparse.mdz2
-rw-r--r--doc/api/build-rules.mdz3
-rw-r--r--doc/api/cc.mdz2
-rw-r--r--doc/api/channel.mdz2
-rw-r--r--doc/api/cjanet.mdz2
-rw-r--r--doc/api/cron.mdz2
-rw-r--r--doc/api/data.mdz2
-rw-r--r--doc/api/ev-utils.mdz2
-rw-r--r--doc/api/fmt.mdz2
-rw-r--r--doc/api/generators.mdz2
-rw-r--r--doc/api/getline.mdz2
-rw-r--r--doc/api/htmlgen.mdz2
-rw-r--r--doc/api/http.mdz2
-rw-r--r--doc/api/httpf.mdz2
-rw-r--r--doc/api/math.mdz2
-rw-r--r--doc/api/mdz.mdz2
-rw-r--r--doc/api/misc.mdz2
-rw-r--r--doc/api/msg.mdz2
-rw-r--r--doc/api/netrepl.mdz2
-rw-r--r--doc/api/path.mdz3
-rw-r--r--doc/api/pgp.mdz2
-rw-r--r--doc/api/randgen.mdz2
-rw-r--r--doc/api/regex.mdz2
-rw-r--r--doc/api/rpc.mdz2
-rw-r--r--doc/api/schema.mdz2
-rw-r--r--doc/api/services.mdz2
-rw-r--r--doc/api/sh.mdz2
-rw-r--r--doc/api/stream.mdz2
-rw-r--r--doc/api/tasker.mdz2
-rw-r--r--doc/api/temple.mdz2
-rw-r--r--doc/api/test.mdz2
31 files changed, 34 insertions, 30 deletions
diff --git a/doc/api/argparse.mdz b/doc/api/argparse.mdz
index be1d2d3..6a7f05a 100644
--- a/doc/api/argparse.mdz
+++ b/doc/api/argparse.mdz
@@ -63,4 +63,4 @@ Run @code`(doc argparse/argparse)` after importing for more information.
## Reference
-@api-docs[../../spork/argparse]
+@api-docs("../../spork" "argparse")
diff --git a/doc/api/build-rules.mdz b/doc/api/build-rules.mdz
index 663f8b8..4bf43cf 100644
--- a/doc/api/build-rules.mdz
+++ b/doc/api/build-rules.mdz
@@ -9,4 +9,5 @@ Use to implement a build system.
## Reference
-@api-docs[../../spork/build-rules]
+@api-docs("../../spork" "build-rules")
+
diff --git a/doc/api/cc.mdz b/doc/api/cc.mdz
index b2256bc..9a0f18e 100644
--- a/doc/api/cc.mdz
+++ b/doc/api/cc.mdz
@@ -27,4 +27,4 @@ Headers, static libraries, and dynamic libraries can all be used from `(dyn *sys
## Reference
-@api-docs[../../spork/cc]
+@api-docs("../../spork" "cc")
diff --git a/doc/api/channel.mdz b/doc/api/channel.mdz
index d1d01b7..9ae49cb 100644
--- a/doc/api/channel.mdz
+++ b/doc/api/channel.mdz
@@ -6,4 +6,4 @@
## Reference
-@api-docs[../../spork/channel]
+@api-docs("../../spork" "channel")
diff --git a/doc/api/cjanet.mdz b/doc/api/cjanet.mdz
index 59b5e0a..94b8be2 100644
--- a/doc/api/cjanet.mdz
+++ b/doc/api/cjanet.mdz
@@ -15,4 +15,4 @@ subset of valid C 99.
## Reference
-@api-docs[../../spork/cjanet]
+@api-docs("../../spork" "cjanet")
diff --git a/doc/api/cron.mdz b/doc/api/cron.mdz
index d368b59..132fd9e 100644
--- a/doc/api/cron.mdz
+++ b/doc/api/cron.mdz
@@ -35,4 +35,4 @@ Note that we have second precision here as opposed to minute precision
## Reference
-@api-docs[../../spork/cron]
+@api-docs("../../spork" "cron")
diff --git a/doc/api/data.mdz b/doc/api/data.mdz
index 3375ff5..7848402 100644
--- a/doc/api/data.mdz
+++ b/doc/api/data.mdz
@@ -40,4 +40,4 @@ The return is @code`@[@{:a 1 :c @{:e 4}} @{:a 4 :c @{:e 5 :f 6}} @{:b 2 :c @{:d
## Reference
-@api-docs[../../spork/data]
+@api-docs("../../spork" "data")
diff --git a/doc/api/ev-utils.mdz b/doc/api/ev-utils.mdz
index 63ae160..a0457ea 100644
--- a/doc/api/ev-utils.mdz
+++ b/doc/api/ev-utils.mdz
@@ -8,4 +8,4 @@ Module for parallel execution utilities with Janet.
## Reference
-@api-docs[../../spork/ev-utils]
+@api-docs("../../spork" "ev-utils")
diff --git a/doc/api/fmt.mdz b/doc/api/fmt.mdz
index 2b40f69..8c555d9 100644
--- a/doc/api/fmt.mdz
+++ b/doc/api/fmt.mdz
@@ -26,4 +26,4 @@ Provides a way to format Janet code strings and files.
## Reference
-@api-docs[../../spork/fmt]
+@api-docs("../../spork" "fmt")
diff --git a/doc/api/generators.mdz b/doc/api/generators.mdz
index 8a0640d..7471b05 100644
--- a/doc/api/generators.mdz
+++ b/doc/api/generators.mdz
@@ -135,5 +135,5 @@ Consume `s` into a new array.
## Reference
-@api-docs[../../spork/generators]
+@api-docs("../../spork" "generators")
diff --git a/doc/api/getline.mdz b/doc/api/getline.mdz
index 2db3d22..1d947b9 100644
--- a/doc/api/getline.mdz
+++ b/doc/api/getline.mdz
@@ -8,4 +8,4 @@ Module for fiber-based sequence combinators rather than array-based combinators,
## Reference
-@api-docs[../../spork/getline]
+@api-docs("../../spork" "getline")
diff --git a/doc/api/htmlgen.mdz b/doc/api/htmlgen.mdz
index 90b5fbd..aeb7a98 100644
--- a/doc/api/htmlgen.mdz
+++ b/doc/api/htmlgen.mdz
@@ -62,4 +62,4 @@ the HTML code from data structures
## Reference
-@api-docs[../../spork/htmlgen]
+@api-docs("../../spork" "htmlgen")
diff --git a/doc/api/http.mdz b/doc/api/http.mdz
index e507be9..426dcc5 100644
--- a/doc/api/http.mdz
+++ b/doc/api/http.mdz
@@ -38,4 +38,4 @@ many clients, servers, and connections at once.
## Reference
-@api-docs[../../spork/http]
+@api-docs("../../spork" "http")
diff --git a/doc/api/httpf.mdz b/doc/api/httpf.mdz
index 9dad96e..38607eb 100644
--- a/doc/api/httpf.mdz
+++ b/doc/api/httpf.mdz
@@ -10,4 +10,4 @@ appropriate metadata.
## Reference
-@api-docs[../../spork/httpf]
+@api-docs("../../spork" "httpf")
diff --git a/doc/api/math.mdz b/doc/api/math.mdz
index b9988a9..eb101bd 100644
--- a/doc/api/math.mdz
+++ b/doc/api/math.mdz
@@ -343,5 +343,5 @@ is provided, and fills it with zeros.
## Reference
-@api-docs[../../spork/math]
+@api-docs("../../spork" "math")
diff --git a/doc/api/mdz.mdz b/doc/api/mdz.mdz
index 9af4379..0631a02 100644
--- a/doc/api/mdz.mdz
+++ b/doc/api/mdz.mdz
@@ -8,4 +8,4 @@ Re-implementation of mendoza markup. Designed to work with htmlgen.
## Reference
-@api-docs[../../spork/mdz]
+@api-docs("../../spork" "mdz")
diff --git a/doc/api/misc.mdz b/doc/api/misc.mdz
index b328821..0542418 100644
--- a/doc/api/misc.mdz
+++ b/doc/api/misc.mdz
@@ -326,4 +326,4 @@ array is not sorted beforehand, the results are undefined. Returns the array.
## Reference
-@api-docs[../../spork/misc]
+@api-docs("../../spork" "misc")
diff --git a/doc/api/msg.mdz b/doc/api/msg.mdz
index daabfd8..56fb931 100644
--- a/doc/api/msg.mdz
+++ b/doc/api/msg.mdz
@@ -24,4 +24,4 @@ level protocols on top of TCP.
## Reference
-@api-docs[../../spork/msg]
+@api-docs("../../spork" "msg")
diff --git a/doc/api/netrepl.mdz b/doc/api/netrepl.mdz
index 62b4867..6d22d48 100644
--- a/doc/api/netrepl.mdz
+++ b/doc/api/netrepl.mdz
@@ -72,4 +72,4 @@ Launch a networked REPL server on one machine and connect to it from another mac
## Reference
-@api-docs[../../spork/netrepl]
+@api-docs("../../spork" "netrepl")
diff --git a/doc/api/path.mdz b/doc/api/path.mdz
index 52e5b46..527cded 100644
--- a/doc/api/path.mdz
+++ b/doc/api/path.mdz
@@ -36,3 +36,6 @@ path/delim # -> ":" on posix, ";" on windows
"a/nested/directory/with/different/children") # -> "../../../different/children"
```
+## Reference
+
+@api-docs("../../spork" "path")
diff --git a/doc/api/pgp.mdz b/doc/api/pgp.mdz
index 3c3cfe3..c21680d 100644
--- a/doc/api/pgp.mdz
+++ b/doc/api/pgp.mdz
@@ -48,5 +48,5 @@ Returns an array of hexs from the string with pgp words.
## Reference
-@api-docs[../../spork/pgp]
+@api-docs("../../spork" "pgp")
diff --git a/doc/api/randgen.mdz b/doc/api/randgen.mdz
index 08e3668..fb85bde 100644
--- a/doc/api/randgen.mdz
+++ b/doc/api/randgen.mdz
@@ -22,6 +22,6 @@ randomly, and another is taken otherwise.
## Reference
-@api-docs[../../spork/randgen]
+@api-docs("../../spork" "randgen")
diff --git a/doc/api/regex.mdz b/doc/api/regex.mdz
index 777bc98..04c455a 100644
--- a/doc/api/regex.mdz
+++ b/doc/api/regex.mdz
@@ -28,6 +28,6 @@ use Janet's native PEG library.
## Reference
-@api-docs[../../spork/regex]
+@api-docs("../../spork" "regex")
diff --git a/doc/api/rpc.mdz b/doc/api/rpc.mdz
index b359626..7a74255 100644
--- a/doc/api/rpc.mdz
+++ b/doc/api/rpc.mdz
@@ -39,5 +39,5 @@ A simple remote procedure call tool for Janet.
## Reference
-@api-docs[../../spork/rpc]
+@api-docs("../../spork" "rpc")
diff --git a/doc/api/schema.mdz b/doc/api/schema.mdz
index 6220533..d07ffa3 100644
--- a/doc/api/schema.mdz
+++ b/doc/api/schema.mdz
@@ -37,4 +37,4 @@ Syntax:
## Reference
-@api-docs[../../spork/schema]
+@api-docs("../../spork" "schema")
diff --git a/doc/api/services.mdz b/doc/api/services.mdz
index e86aa9f..d1cdcdc 100644
--- a/doc/api/services.mdz
+++ b/doc/api/services.mdz
@@ -9,4 +9,4 @@ Similar to ev-utils, but more involved with defaults for IO and naming fibers fo
## Reference
-@api-docs[../../spork/services]
+@api-docs("../../spork" "services")
diff --git a/doc/api/sh.mdz b/doc/api/sh.mdz
index 9553084..d55d941 100644
--- a/doc/api/sh.mdz
+++ b/doc/api/sh.mdz
@@ -8,4 +8,4 @@ Shell utilities for Janet.
## Reference
-@api-docs[../../spork/sh]
+@api-docs("../../spork" "sh")
diff --git a/doc/api/stream.mdz b/doc/api/stream.mdz
index 852a695..4328b5b 100644
--- a/doc/api/stream.mdz
+++ b/doc/api/stream.mdz
@@ -8,4 +8,4 @@ Stream utilities for Janet.
## Reference
-@api-docs[../../spork/stream]
+@api-docs("../../spork" "stream")
diff --git a/doc/api/tasker.mdz b/doc/api/tasker.mdz
index e109ef3..a4f8bba 100644
--- a/doc/api/tasker.mdz
+++ b/doc/api/tasker.mdz
@@ -8,4 +8,4 @@ A simple task executor library/server.
## Reference
-@api-docs[../../spork/tasker]
+@api-docs("../../spork" "tasker")
diff --git a/doc/api/temple.mdz b/doc/api/temple.mdz
index 19bf356..b6392a9 100644
--- a/doc/api/temple.mdz
+++ b/doc/api/temple.mdz
@@ -52,5 +52,5 @@ There is one more involved example in
## Reference
-@api-docs[../../spork/temple]
+@api-docs("../../spork" "temple")
diff --git a/doc/api/test.mdz b/doc/api/test.mdz
index bcadbbb..c22da20 100644
--- a/doc/api/test.mdz
+++ b/doc/api/test.mdz
@@ -155,5 +155,5 @@ when the `path` is required.
## Reference
-@api-docs[../../spork/test]
+@api-docs("../../spork" "test")