mirror/guix
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/guix.git synced 2025-02-07 11:29:59 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Add support for "guix-cookbook.texi" to 'build.scm'.

Browse source 
* doc/build.scm (%manual): New variable.
(html-manual): #:manual now defaults to %MANUAL.
[build]: Define 'language->texi-file-name' and use it.  Filter out items
of LANGUAGES that lack a .texi file.
(pdf-manual, html-manual-indexes, pdf+html-manual): #:manual now
defaults to %MANUAL.
This commit is contained in:
Ludovic Courtès 2019-10-21 18:01:45 +02:00
parent 5f15b42273
commit cacb5576cc
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5
1 changed files with 24 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
doc/build.scm
View file

@ -51,6 +51,12 @@
(define info-manual (define info-manual
(@@ (guix self) info-manual)) (@@ (guix self) info-manual))
(define %manual
;; The manual to build--i.e., the base name of a .texi file, such as "guix"
;; or "guix-cookbook".
(or (getenv "GUIX_MANUAL")
"guix"))
(define %languages (define %languages
'("de" "en" "es" "fr" "ru" "zh_CN")) '("de" "en" "es" "fr" "ru" "zh_CN"))
@ -359,7 +365,7 @@ its <pre class=\"lisp\"> blocks (as produced by 'makeinfo --html')."
(define* (html-manual source #:key (languages %languages) (define* (html-manual source #:key (languages %languages)
(version "0.0") (version "0.0")
(manual "guix") (manual %manual)
(date 1) (date 1)
(options %makeinfo-html-options)) (options %makeinfo-html-options))
"Return the HTML manuals built from SOURCE for all LANGUAGES, with the given "Return the HTML manuals built from SOURCE for all LANGUAGES, with the given
@ -386,6 +392,13 @@ makeinfo OPTIONS."
(chr chr)) (chr chr))
(string-downcase language))) (string-downcase language)))
(define (language->texi-file-name language)
(if (string=? language "en")
(string-append #$manual-source "/"
#$manual ".texi")
(string-append #$manual-source "/"
#$manual "." language ".texi")))
;; Install a UTF-8 locale so that 'makeinfo' is at ease. ;; Install a UTF-8 locale so that 'makeinfo' is at ease.
(setenv "GUIX_LOCPATH" (setenv "GUIX_LOCPATH"
#+(file-append glibc-utf8-locales "/lib/locale")) #+(file-append glibc-utf8-locales "/lib/locale"))
@ -395,15 +408,12 @@ makeinfo OPTIONS."
(setvbuf (current-error-port) 'line) (setvbuf (current-error-port) 'line)
(for-each (lambda (language) (for-each (lambda (language)
(let ((opts `("--html" (let* ((texi (language->texi-file-name language))
"-c" ,(string-append "TOP_NODE_UP_URL=/manual/" (opts `("--html"
"-c" ,(string-append "TOP_NODE_UP_URL=/manual/"
language) language)
#$@options #$@options
,(if (string=? language "en") ,texi)))
(string-append #$manual-source "/"
#$manual ".texi")
(string-append #$manual-source "/"
#$manual "." language ".texi")))))
(format #t "building HTML manual for language '~a'...~%" (format #t "building HTML manual for language '~a'...~%"
language) language)
(mkdir-p (string-append #$output "/" (mkdir-p (string-append #$output "/"
@ -433,7 +443,8 @@ makeinfo OPTIONS."
(symlink #$images (symlink #$images
(string-append #$output "/" (normalize language) (string-append #$output "/" (normalize language)
"/html_node/images")))) "/html_node/images"))))
'#$languages)))) (filter (compose file-exists? language->texi-file-name)
'#$languages)))))
(let* ((name (string-append manual "-html-manual")) (let* ((name (string-append manual "-html-manual"))
(manual (computed-file name build))) (manual (computed-file name build)))
@ -442,7 +453,7 @@ makeinfo OPTIONS."
(define* (pdf-manual source #:key (languages %languages) (define* (pdf-manual source #:key (languages %languages)
(version "0.0") (version "0.0")
(manual "guix") (manual %manual)
(date 1) (date 1)
(options '())) (options '()))
"Return the HTML manuals built from SOURCE for all LANGUAGES, with the given "Return the HTML manuals built from SOURCE for all LANGUAGES, with the given
@ -570,7 +581,7 @@ from SOURCE."
(define* (html-manual-indexes source (define* (html-manual-indexes source
#:key (languages %languages) #:key (languages %languages)
(version "0.0") (version "0.0")
(manual "guix") (manual %manual)
(date 1)) (date 1))
(define build (define build
(with-extensions (list guile-json-3) (with-extensions (list guile-json-3)
@ -782,7 +793,7 @@ languages:\n"
#:key (languages %languages) #:key (languages %languages)
(version "0.0") (version "0.0")
(date (time-second (current-time time-utc))) (date (time-second (current-time time-utc)))
(manual "guix")) (manual %manual))
"Return the union of the HTML and PDF manuals, as well as the indexes." "Return the union of the HTML and PDF manuals, as well as the indexes."
(directory-union (string-append manual "-manual") (directory-union (string-append manual "-manual")
(map (lambda (proc) (map (lambda (proc)