summary refs log tree commit diff
path: root/gnu/packages/libftdi.scm
diff options
context:
space:
mode:
authorSimon South <simon@simonsouth.net>2023-09-07 12:37:58 -0400
committerLudovic Courtès <ludo@gnu.org>2023-09-14 23:37:34 +0200
commita5bc9f233f630e06b05f3029b181ba951502c00d (patch)
treec80efd03aeb45461dbb0b78a0bb66c3911e6696e /gnu/packages/libftdi.scm
parent6c4868aca9e098fd7c830ba681ae0735aa752bdd (diff)
downloadguix-a5bc9f233f630e06b05f3029b181ba951502c00d.tar.gz
gnu: libftdi: Build API documentation.
* gnu/packages/libftdi.scm (libftdi)[outputs]: Add "doc" output.
[arguments]<#:configure-flags>: Add "-DDOCUMENTATION".
<#:phases>: Add "install-documentation" phase.
[native-inputs]: Add doxygen, graphviz.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Diffstat (limited to 'gnu/packages/libftdi.scm')
-rw-r--r--gnu/packages/libftdi.scm18
1 files changed, 15 insertions, 3 deletions
diff --git a/gnu/packages/libftdi.scm b/gnu/packages/libftdi.scm
index bdfc635379..02efcbbbc0 100644
--- a/gnu/packages/libftdi.scm
+++ b/gnu/packages/libftdi.scm
@@ -28,6 +28,8 @@
   #:use-module (guix utils)
   #:use-module (gnu packages)
   #:use-module (gnu packages boost)
+  #:use-module (gnu packages documentation)
+  #:use-module (gnu packages graphviz)
   #:use-module (gnu packages libusb)
   #:use-module (gnu packages pkg-config)
   #:use-module (gnu packages python)
@@ -49,12 +51,13 @@
               (patches
                (search-patches "libftdi-fix-paths-when-FTDIPP-set.patch"))))
     (build-system cmake-build-system)
-    (outputs '("out" "python"))
+    (outputs '("out" "doc" "python"))
     (arguments
      (list
       #:configure-flags
       #~(list (string-append "-DCMAKE_INSTALL_DOCDIR="
                              #$output "/share/doc/" #$name "-" #$version)
+              "-DDOCUMENTATION=ON"
               "-DEXAMPLES=OFF"
               "-DFTDIPP=ON"
               "-DLIB_SUFFIX=''"         ; place libraries in /lib, not /lib64
@@ -74,11 +77,20 @@
                 (rename-file (string-append #$output
                                             "/share/libftdi/examples")
                              (string-append #$output:python
-                                            "/share/libftdi/examples"))))))
+                                            "/share/libftdi/examples")))))
+          (add-after 'install-python-binding 'install-documentation
+            (lambda _
+              (let ((share (string-append #$output:doc "/share")))
+                (copy-recursively "doc/man"
+                                  (string-append share "/man"))
+                (copy-recursively "doc/html"
+                                  (string-append share "/doc/"
+                                                 #$name "-" #$version
+                                                 "/html"))))))
       #:test-target "check"
       #:tests? #f))                     ; tests fail without access to USB
     (native-inputs
-     (list pkg-config python swig))
+     (list doxygen graphviz pkg-config python swig))
     (inputs
      (list boost libconfuse))
     (propagated-inputs