diff mbox series

[bug#40944] doc: Fix building the cookbook

Message ID 20200428193523.4ba547dc@alma-ubu
State Accepted
Headers show
Series [bug#40944] doc: Fix building the cookbook | expand

Checks

Context Check Description
cbaines/comparison success View comparision
cbaines/git branch success View Git branch
cbaines/applying patch fail View Laminar job

Commit Message

Björn Höfling April 28, 2020, 5:35 p.m. UTC 
As reported in

https://debbugs.gnu.org/cgi/bugreport.cgi?bug=40803

there are problems with the cookbook:

* The single-page html file was missing.
* Languages other than English and German don't make sense: There is no
translation available.

The attached patch fixes these problems.

Björn

Comments

Ludovic Courtès May 2, 2020, 11:05 a.m. UTC | #1 
Hi Björn,

Björn Höfling <bjoern.hoefling@bjoernhoefling.de> skribis:

> From 0bea22f4b21b013633d6d921da824d1240c7cc4d Mon Sep 17 00:00:00 2001
> From: =?UTF-8?q?Bj=C3=B6rn=20H=C3=B6fling?=
>  <bjoern.hoefling@bjoernhoefling.de>
> Date: Tue, 28 Apr 2020 13:51:31 +0200
> Subject: [PATCH] doc: Fix building the cookbook.
>
> Fixes <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=40803>.
> Reported by "operator.name" <operator.name@protonmail.com>.
>
> * doc/build.scm (%languages): Add smaller list for the cookbook.
> (syntax-highlighted-html): Adapt regexp for mono-node files to include
> the cookbook.
> ---
>  doc/build.scm | 9 +++++++--
>  1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/doc/build.scm b/doc/build.scm
> index 3907b49caf..31c4c3d122 100644
> --- a/doc/build.scm
> +++ b/doc/build.scm
> @@ -58,7 +58,10 @@
>        "guix"))
>  
>  (define %languages
> -  '("de" "en" "es" "fr" "ru" "zh_CN"))
> +  ;; The cookbook is currently only translated into German.
> +  (if (string=? %manual "guix-cookbook")
> +      '("de" "en")
> +      '("de" "en" "es" "fr" "ru" "zh_CN")))
>  
>  (define (texinfo-manual-images source)
>    "Return a directory containing all the images used by the user manual, taken
> @@ -451,7 +454,9 @@ its <pre class=\"lisp\"> blocks (as produced by 'makeinfo --html')."
>                              (lambda (mono)
>                                (let ((anchors (collect-anchors mono)))
>                                  (process-html mono anchors)))
> -                            (find-files #$input "^guix(\\.[a-zA-Z_-]+)?\\.html$"))
> +                            (find-files
> +                             #$input
> +                             "^guix(-cookbook|)(\\.[a-zA-Z_-]+)?\\.html$"))

LGTM!

Thanks,
Ludo’.
Björn Höfling May 2, 2020, 11:29 a.m. UTC | #2 
On Sat, 02 May 2020 13:05:00 +0200
Ludovic Courtès <ludo@gnu.org> wrote:

> Hi Björn,
> 
> Björn Höfling <bjoern.hoefling@bjoernhoefling.de> skribis:
> 
> > Fixes <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=40803>.
> > Reported by "operator.name" <operator.name@protonmail.com>.
> >

> LGTM!
> 
> Thanks,
> Ludo’.

Thanks,

pushed as 7c65fc378cf68b598965fd977f5844050435ac97.

Björn
Björn Höfling May 2, 2020, 11:29 a.m. UTC | #3 
... and closing.

Björn
diff mbox series

Patch

From 0bea22f4b21b013633d6d921da824d1240c7cc4d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20H=C3=B6fling?=
 <bjoern.hoefling@bjoernhoefling.de>
Date: Tue, 28 Apr 2020 13:51:31 +0200
Subject: [PATCH] doc: Fix building the cookbook.

Fixes <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=40803>.
Reported by "operator.name" <operator.name@protonmail.com>.

* doc/build.scm (%languages): Add smaller list for the cookbook.
(syntax-highlighted-html): Adapt regexp for mono-node files to include
the cookbook.
---
 doc/build.scm | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/doc/build.scm b/doc/build.scm
index 3907b49caf..31c4c3d122 100644
--- a/doc/build.scm
+++ b/doc/build.scm
@@ -58,7 +58,10 @@ 
       "guix"))
 
 (define %languages
-  '("de" "en" "es" "fr" "ru" "zh_CN"))
+  ;; The cookbook is currently only translated into German.
+  (if (string=? %manual "guix-cookbook")
+      '("de" "en")
+      '("de" "en" "es" "fr" "ru" "zh_CN")))
 
 (define (texinfo-manual-images source)
   "Return a directory containing all the images used by the user manual, taken
@@ -451,7 +454,9 @@  its <pre class=\"lisp\"> blocks (as produced by 'makeinfo --html')."
                             (lambda (mono)
                               (let ((anchors (collect-anchors mono)))
                                 (process-html mono anchors)))
-                            (find-files #$input "^guix(\\.[a-zA-Z_-]+)?\\.html$"))
+                            (find-files
+                             #$input
+                             "^guix(-cookbook|)(\\.[a-zA-Z_-]+)?\\.html$"))
 
             ;; Next process the multi-node HTML files in two phases: (1)
             ;; collect the list of anchors, and (2) perform
-- 
2.26.0