doc/: start generating API documentation from docstrings

Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>

3 files changed, 27 insertions, 26 deletions

diff --git a/src/property/chroot.lisp b/src/property/chroot.lisp
index 3e790d3..068c86b 100644
--- a/src/property/chroot.lisp
+++ b/src/property/chroot.lisp
@@ -100,7 +100,7 @@
                              ,(propspec-props propspec))))))
 
 (defproplist deploys :lisp (root host &optional additional-properties)
-  "Like DEPLOYS with first argument `((:chroot :into ,root)), but disable
+  "Like DEPLOYS with first argument ```((:chroot :into ,root))``, but disable
 starting services in the chroot, and set up access to parent hostattrs."
   (:desc #?"Subdeployment of ${root}")
   (consfigurator:deploys
@@ -108,8 +108,9 @@ starting services in the chroot, and set up access to parent hostattrs."
    (%make-child-host (union-propspec-into-host host additional-properties))))
 
 (defproplist deploys-these :lisp (root host properties)
-  "Like DEPLOYS-THESE with first argument `((:chroot :into ,root)), but disable
-starting services in the chroot, and set up access to parent hostattrs."
+  "Like DEPLOYS-THESE with first argument ```((:chroot :into ,root))``, but
+disable starting services in the chroot, and set up access to parent
+hostattrs."
   (:desc #?"Subdeployment of ${root}")
   (consfigurator:deploys
    `((:chroot :into ,root))
diff --git a/src/property/cron.lisp b/src/property/cron.lisp
index f60ecb8..2a3e7fe 100644
--- a/src/property/cron.lisp
+++ b/src/property/cron.lisp
@@ -21,10 +21,10 @@
 ;;; A number of techniques here are from Propellor's Cron properties module.
 
 (defpropspec system-job :posix (desc when user shell-command)
-  "Installs a cronjob running SHELL-COMMAND as USER to /etc/cron.*.
+  "Installs a cronjob running SHELL-COMMAND as USER to ``/etc/cron.*``.
 DESC must be unique, as it will be used as a filename for a script.  WHEN is
 either :DAILY, WEEKLY, :MONTHLY or a string formatted according to crontab(5),
-e.g. \"0 3 * * *\".
+e.g. ``0 3 * * *``.
 
 The output of the cronjob will be mailed only if the job exits nonzero."
   (:desc #?"Cronned ${desc}")
diff --git a/src/property/disk.lisp b/src/property/disk.lisp
index 4c650f9..f7b7b3d 100644
--- a/src/property/disk.lisp
+++ b/src/property/disk.lisp
@@ -998,7 +998,7 @@ filesystems will be incrementally updated when other properties change."
     (options host device-file &key chroot)
   "Install HOST to the DISK:PHYSICAL-DISK accessible at DEVICE-FILE.
 **THIS PROPERTY UNCONDITIONALLY FORMATS DISKS, POTENTIALLY DESTROYING DATA,
-  EACH TIME IT IS APPLIED.**
+EACH TIME IT IS APPLIED.**
 
 Do not apply in DEFHOST.  Apply with DEPLOY-THESE/HOSTDEPLOY-THESE.
 
@@ -1046,7 +1046,7 @@ the host's actual physical disk upon first boot."
 (defpropspec volumes-installed-for :lisp (options host &key chroot leave-open)
   "Install HOST to its volumes, as specified using DISK:HAS-VOLUMES.
 **THIS PROPERTY UNCONDITIONALLY FORMATS DISKS, POTENTIALLY DESTROYING DATA,
-  EACH TIME IT IS APPLIED.**
+EACH TIME IT IS APPLIED.**
 
 Do not apply in DEFHOST.  Apply with DEPLOY-THESE/HOSTDEPLOY-THESE.
 
@@ -1233,28 +1233,28 @@ specifications.  This becomes the VOLUME-CONTENTS of the VOLUME.
 
 The following keys in INITARGS are handled specially:
 
-    - :VOLUME-SIZE -- may be a string like \"100M\", \"2G\", \"1T\" which will
-      be converted into a whole number of mebibytes.  \"M\", \"G\", and \"T\"
-      are currently supported.
+  - :VOLUME-SIZE -- may be a string like \"100M\", \"2G\", \"1T\" which will
+    be converted into a whole number of mebibytes.  \"M\", \"G\", and \"T\"
+    are currently supported.
 
 Example usage:
 
-  (volumes
-    (physical-disk
-     (partitioned-volume
-      ((partition
-        :partition-typecode #xef00
-        (fat32-filesystem
-         :volume-size \"512M\"
-         :mount-point #P\"/boot/efi\"))
-       (partition
-        (luks-container
-         (lvm-physical-volume
-          :volume-group \"vg_laptop\"))))))
-    (lvm-logical-volume
-       :volume-group \"vg_laptop\"
-       :volume-label \"lv_laptop_root\"
-       (ext4-filesystem :mount-point #P\"/\")))"
+    (volumes
+      (physical-disk
+       (partitioned-volume
+        ((partition
+          :partition-typecode #xef00
+          (fat32-filesystem
+           :volume-size \"512M\"
+           :mount-point #P\"/boot/efi\"))
+         (partition
+          (luks-container
+           (lvm-physical-volume
+            :volume-group \"vg_laptop\"))))))
+      (lvm-logical-volume
+         :volume-group \"vg_laptop\"
+         :volume-label \"lv_laptop_root\"
+         (ext4-filesystem :mount-point #P\"/\")))"
   (labels
       ((parse (spec)
          (unless (listp spec)