GNU bug report logs - #78825
[PATCH] gnu: Add guile-documenta.

Previous Next

To reply to this bug, email your comments to 78825 AT debbugs.gnu.org.
There is no need to reopen the bug first.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Christopher Baines <mail <at> cbaines.net>
To: guix-patches <at> gnu.org
Subject: [PATCH] gnu: Add guile-documenta.
Date: Wed, 18 Jun 2025 14:48:14 +0100

* gnu/packages/guile-xyz.scm (guile-documenta): New variable.

Change-Id: I86cc729ecb4d367c066fb5bd2278c62cc255b738
---
 gnu/packages/guile-xyz.scm | 76 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)

diff --git a/gnu/packages/guile-xyz.scm b/gnu/packages/guile-xyz.scm
index fabe887bfe..ec48c814f7 100644
--- a/gnu/packages/guile-xyz.scm
+++ b/gnu/packages/guile-xyz.scm
@@ -81,6 +81,7 @@ (define-module (gnu packages guile-xyz)
   #:use-module (gnu packages base)
   #:use-module (gnu packages bash)
   #:use-module (gnu packages compression)
+  #:use-module (gnu packages check)
   #:use-module (gnu packages crypto)
   #:use-module (gnu packages curl)
   #:use-module (gnu packages databases)
@@ -788,6 +789,81 @@ (define-public guile-daemon
 you send to a FIFO file.")
     (license license:gpl3+)))
 
+(define-public guile-documenta
+  (package
+    (name "guile-documenta")
+    (version "0.2.1")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url "https://codeberg.org/luis-felipe/guile-documenta")
+             (commit version)))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "1jv8nd7hlrsg2v2p5wacs8x3rzmhxwcg83pjsrnwks346jvsfxnv"))))
+    (build-system guile-build-system)
+    (inputs
+     (list bash-minimal
+           guile-3.0))
+    (native-inputs
+     (list texinfo
+           guile-proba))
+    (propagated-inputs
+     (list guile-config
+           guile-lib))
+    (arguments
+     (list
+      #:phases
+      #~(modify-phases %standard-phases
+          (add-after 'set-paths 'add-output-to-guile-load-paths
+            (lambda* (#:key outputs #:allow-other-keys)
+              (let* ((out (assoc-ref outputs "out"))
+                     (guile-version (target-guile-effective-version))
+                     (scm-path (string-append out
+                                              "/share/guile/site/"
+                                              guile-version))
+                     (go-path (string-append out
+                                             "/lib/guile/"
+                                             guile-version
+                                             "/site-ccache")))
+                (setenv "GUILE_LOAD_PATH"
+                        (string-append scm-path ":"
+                                       (getenv "GUILE_LOAD_PATH")))
+                (setenv "GUILE_LOAD_COMPILED_PATH"
+                        (string-append
+                         go-path ":"
+                         (getenv "GUILE_LOAD_COMPILED_PATH"))))))
+          (add-after 'build 'build-manual
+            (lambda _
+              (invoke "bash" "build-manual.sh")))
+          (add-after 'build 'check
+            (lambda* (#:key tests? #:allow-other-keys)
+              (when tests?
+                (invoke "proba" "run" "tests"))))
+          (add-after 'check 'install-wrapped-script
+            (lambda* (#:key outputs #:allow-other-keys)
+              (let* ((out (assoc-ref outputs "out"))
+                     (bin-dir (string-append out "/bin"))
+                     (script (string-append bin-dir "/documenta")))
+                (mkdir-p bin-dir)
+                (copy-file "documenta.scm" script)
+                (chmod script #o555)
+                (wrap-program script
+                  `("GUILE_LOAD_PATH" prefix (,(getenv "GUILE_LOAD_PATH")))
+                  `("GUILE_LOAD_COMPILED_PATH" prefix
+                    (,(getenv "GUILE_LOAD_COMPILED_PATH"))))))))
+      #:scheme-file-regexp
+      #~(begin
+          (use-modules (ice-9 regex))
+          (lambda (file stat) (string-match "/documenta/.*\\.scm$" file)))))
+    (home-page "https://luis-felipe.gitlab.io/guile-documenta/")
+    (synopsis "Ggenerate API documentation for Guile projects")
+    (description
+     "Guile Documentá is a command-line program and accompanying library to
+generate API documentation for GNU Guile projects.")
+    (license license:public-domain)))
+
 (define-public guile-dsv
   (package
     (name "guile-dsv")

base-commit: d276296a6f8d09cc8fcbe927abb67dca52a71667
-- 
2.49.0

Message #8 received at 78825 <at> debbugs.gnu.org (full text, mbox):

From: Andreas Enge <andreas <at> enge.fr>
To: Christopher Baines <mail <at> cbaines.net>
Cc: 78825 <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: Add guile-documenta.
Date: Wed, 18 Jun 2025 22:06:54 +0200

Hello, a little typo in the synopsis ("Gg").

Andreas

Message #13 received at 78825-done <at> debbugs.gnu.org (full text, mbox):

From: jgart <jgart <at> dismail.de>
To: 78825-done <at> debbugs.gnu.org
Cc: Andreas Enge <andreas <at> enge.fr>, Christopher Baines <mail <at> cbaines.net>
Subject: Re: [PATCH] gnu: Add guile-documenta.
Date: Thu, 19 Jun 2025 00:32:10 -0400

LGTM! I fixed the typo and pushed.

> Hello, a little typo in the synopsis ("Gg").
> 
> Andreas
<#secure method=pgpmime mode=sign>

-- 
all the best,
jgart

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.