make building the PDF optional

Iterating on contents takes way too much time otherwise.

Author: fricklerhandwerk

.github/workflows/build-and-deploy.yml

@@ -23,7 +23,7 @@ jobs:
 
     - name: Build
       run: |
-        nix-build --arg withManuals true
+        nix-build --arg withManuals true --arg withPDF true
 
         # The netlify action doesn't follow symlinks properly.
         mkdir ./dist

CONTRIBUTING.md

@@ -37,6 +37,16 @@ To enable building the manuals:
 [nix-shell:nix.dev]$ devmode --arg withManuals true
 ```
 
+## Building the PDF
+
+By default, nix.dev is built without the PDF rendering, as that is takes too long for quick iteration on the contents.
+To enable building the PDF:
+
+```shell-session
+[nix-shell:nix.dev]$ nix-build -A build --arg withPDF true
+[nix-shell:nix.dev]$ devmode --arg withPDF true
+```
+
 ## Updating reference manuals
 
 With the current setup, the [Nix manual hosted on nix.dev](https://nix.dev/reference/nix-manual) does not get updated automatically with new releases.

default.nix

@@ -7,6 +7,7 @@
     inherit system;
   },
   withManuals ? false, # building the manuals is expensive
+  withPDF ? false, # building the PDF is expensive
 }:
 let
   lib = pkgs.lib;
@@ -53,7 +54,7 @@ let
       ''
         ${lib.optionalString withManuals "cp -f ${substitutedNixManualReference} source/reference/nix-manual.md"}
         make html
-        make latexpdf
+        ${lib.optionalString withPDF "make latexpdf"}
       '';
     installPhase =
       let
@@ -80,7 +81,7 @@ let
       ''
         mkdir -p $out/manual/nix
         cp -R build/html/* $out/
-        cp build/latex/nix-dev.pdf $out/
+        ${lib.optionalString withPDF "cp build/latex/nix-dev.pdf $out/"}
         cp netlify.toml $out/
       ''
       + lib.optionalString withManuals ''
@@ -90,7 +91,7 @@ let
   };
 
   devmode = pkgs.devmode.override {
-    buildArgs = ''-A build --show-trace'';
+    buildArgs = "-A build --show-trace";
     open = "/index.html";
   };
   update-nix-releases = pkgs.callPackage ./nix/update-nix-releases.nix { };

source/_templates/download-links.html

@@ -1 +1 @@
-<p>nix.dev as <a href="/nix-dev.pdf">PDF</a></p>
+<p><a href="/nix-dev.pdf">nix.dev as PDF</a></p>