Add docstring build task

Adds a Clojure script to add docstrings from Duct libraries into the
documentation.

Author: weavejester

.github/workflows/asciidoc.yml

@@ -18,11 +18,15 @@ jobs:
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
+      - name: Install clojure tools
+        uses: DeLaGuardo/[email protected]
+        with:
+          bb: latest
+      - name: Install AsciiDoctor
+        run: sudo apt install -y asciidoctor
       - name: Run ASCIIDoc
         id: adocbuild
-        uses: tonynv/asciidoctor-action@master
-        with:
-          program: "asciidoctor -D build index.adoc"
+        run: bb build
       - name: Print execution time
         run: echo "Time ${{ steps.adocbuild.outputs.time }}"
       - name: Upload artifact

.gitignore

@@ -1,2 +1,4 @@
 build/
 .clj-kondo/
+.cpcache/
+keywords.adoc

bb.edn

@@ -1,2 +1,6 @@
 {:tasks
- {build (shell "asciidoctor -D build -b html5 index.adoc")}}
+ {docstrings
+  {:task (clojure "-M" "build.clj")}
+  build
+  {:depends [docstrings]
+   :task (shell "asciidoctor -D build -b html5 index.adoc")}}}

build.clj

@@ -0,0 +1,23 @@
+(ns build
+  (:require [clojure.java.io :as io]
+            [clojure.string :as str]
+            [integrant.core :as ig]))
+
+(defn- ->asciidoc [s]
+  (-> s
+      (str/replace #"(?m)^  " "")
+      (str/replace #"(\n[^-][^\n]*)\n-" "$1\n\n-")))
+
+(def keywords
+  [:duct.logger/simple
+   :duct.module/logging])
+
+(ig/load-annotations)
+
+(with-open [writer (io/writer "keywords.adoc")]
+  (binding [*out* writer]
+    (doseq [kw (sort keywords)]
+      (println (str "=== " kw))
+      (newline)
+      (println (->asciidoc (:doc (ig/describe kw))))
+      (newline))))

deps.edn

@@ -0,0 +1,4 @@
+{:paths ["."]
+ :deps {org.clojure/clojure {:mvn/version "1.12.2"}
+        integrant/integrant {:mvn/version "1.0.0"}
+        org.duct-framework/module.logging {:mvn/version "0.6.6"}}}

index.adoc

@@ -2022,3 +2022,7 @@ clj꞉user꞉> (go)
 
 To reset the project, you can use `(reset)` at the REPL, or run the
 command: *Calva: Refresh All Namespaces*.
+
+== Keywords
+
+include::keywords.adoc[]