···

       
17
       
 
       
	-f commonmark$(pandoc_commonmark_enabled_extensions)+smart

     

       
18
       
 
       


     

       
19
       
 
       
.PHONY: all

     

       
20
       
-
       
all: validate format out/html/index.html out/epub/manual.epub

     

       
21
       
 
       


     

       
22
       
 
       
.PHONY: render-md

     

       
23
       
 
       
render-md: ${MD_TARGETS}

     
···

       
65
       
 
       
	mkdir -p out/html/images/callouts

     

       
66
       
 
       
	cp doc-support/result/xsl/docbook/images/callouts/*.svg out/html/images/callouts/

     

       
67
       
 
       
	chmod u+w -R out/html/

     

       
68
       
-
       


     

       
69
       
-
       
out/epub/manual.epub: epub.xml

     

       
70
       
-
       
	mkdir -p out/epub/scratch

     

       
71
       
-
       
	xsltproc --nonet \

     

       
72
       
-
       
		--output out/epub/scratch/ \

     

       
73
       
-
       
		doc-support/result/epub.xsl \

     

       
74
       
-
       
		./epub.xml

     

       
75
       
-
       


     

       
76
       
-
       
	echo "application/epub+zip" > mimetype

     

       
77
       
-
       
	zip -0Xq "out/epub/manual.epub" mimetype

     

       
78
       
-
       
	rm mimetype

     

       
79
       
-
       
	cd "out/epub/scratch/" && zip -Xr9D "../manual.epub" *

     

       
80
       
-
       
	rm -rf "out/epub/scratch/"

     

       
81
       
 
       


     

       
82
       
 
       
highlightjs: doc-support/result

     

       
83
       
 
       
	mkdir -p highlightjs

     

···

       
17
       
 
       
	-f commonmark$(pandoc_commonmark_enabled_extensions)+smart

     

       
18
       
 
       


     

       
19
       
 
       
.PHONY: all

     

       
20
       
+
       
all: validate format out/html/index.html

     

       
21
       
 
       


     

       
22
       
 
       
.PHONY: render-md

     

       
23
       
 
       
render-md: ${MD_TARGETS}

     
···

       
65
       
 
       
	mkdir -p out/html/images/callouts

     

       
66
       
 
       
	cp doc-support/result/xsl/docbook/images/callouts/*.svg out/html/images/callouts/

     

       
67
       
 
       
	chmod u+w -R out/html/

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
68
       
 
       


     

       
69
       
 
       
highlightjs: doc-support/result

     

       
70
       
 
       
	mkdir -p highlightjs

     

···

       
1
       
 
       
{ pkgs ? (import ./.. { }), nixpkgs ? { }}:

     

       
2
       
 
       
let

     

       
3
       
 
       
  doc-support = import ./doc-support { inherit pkgs nixpkgs; };

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
4
       
 
       
in pkgs.stdenv.mkDerivation {

     

       
5
       
 
       
  name = "nixpkgs-manual";

     

       
6
       
 
       


     
···

       
20
       
 
       
    ln -s ${doc-support} ./doc-support/result

     

       
21
       
 
       
  '';

     

       
22
       
 
       


     

       
23
       
-
       
  epub = ''

     

       
24
       
-
       
    <book xmlns="http://docbook.org/ns/docbook"

     

       
25
       
-
       
          xmlns:xlink="http://www.w3.org/1999/xlink"

     

       
26
       
-
       
          version="5.0"

     

       
27
       
-
       
          xml:id="nixpkgs-manual">

     

       
28
       
-
       
      <info>

     

       
29
       
-
       
        <title>Nixpkgs Manual</title>

     

       
30
       
-
       
        <subtitle>Version ${pkgs.lib.version}</subtitle>

     

       
31
       
-
       
      </info>

     

       
32
       
-
       
      <chapter>

     

       
33
       
-
       
        <title>Temporarily unavailable</title>

     

       
34
       
-
       
        <para>

     

       
35
       
-
       
          The Nixpkgs manual is currently not available in EPUB format,

     

       
36
       
-
       
          please use the <link xlink:href="https://nixos.org/nixpkgs/manual">HTML manual</link>

     

       
37
       
-
       
          instead.

     

       
38
       
-
       
        </para>

     

       
39
       
-
       
        <para>

     

       
40
       
-
       
          If you've used the EPUB manual in the past and it has been useful to you, please

     

       
41
       
-
       
          <link xlink:href="https://github.com/NixOS/nixpkgs/issues/237234">let us know</link>.

     

       
42
       
-
       
        </para>

     

       
43
       
-
       
      </chapter>

     

       
44
       
-
       
    </book>

     

       
45
       
-
       
  '';

     

       
46
       
-
       
  passAsFile = [ "epub" ];

     

       
47
       
-
       


     

       
48
       
 
       
  preBuild = ''

     

       
49
       
-
       
    cp $epubPath epub.xml

     

       
50
       
 
       
    make -j$NIX_BUILD_CORES render-md

     

       
51
       
 
       
  '';

     

       
52
       
 
       


     
···

       
56
       
 
       
    mv out/html "$dest"

     

       
57
       
 
       
    mv "$dest/index.html" "$dest/manual.html"

     

       
58
       
 
       


     

       
59
       
-
       
    mv out/epub/manual.epub "$dest/nixpkgs-manual.epub"

     

       
60
       
 
       


     

       
61
       
 
       
    mkdir -p $out/nix-support/

     

       
62
       
 
       
    echo "doc manual $dest manual.html" >> $out/nix-support/hydra-build-products

     

···

       
1
       
 
       
{ pkgs ? (import ./.. { }), nixpkgs ? { }}:

     

       
2
       
 
       
let

     

       
3
       
 
       
  doc-support = import ./doc-support { inherit pkgs nixpkgs; };

     

       
4
       
+
       


     

       
5
       
+
       
  epub = pkgs.runCommand "manual.epub" {

     

       
6
       
+
       
    nativeBuildInputs = with pkgs; [ libxslt zip ];

     

       
7
       
+
       


     

       
8
       
+
       
    epub = ''

     

       
9
       
+
       
      <book xmlns="http://docbook.org/ns/docbook"

     

       
10
       
+
       
            xmlns:xlink="http://www.w3.org/1999/xlink"

     

       
11
       
+
       
            version="5.0"

     

       
12
       
+
       
            xml:id="nixpkgs-manual">

     

       
13
       
+
       
        <info>

     

       
14
       
+
       
          <title>Nixpkgs Manual</title>

     

       
15
       
+
       
          <subtitle>Version ${pkgs.lib.version}</subtitle>

     

       
16
       
+
       
        </info>

     

       
17
       
+
       
        <chapter>

     

       
18
       
+
       
          <title>Temporarily unavailable</title>

     

       
19
       
+
       
          <para>

     

       
20
       
+
       
            The Nixpkgs manual is currently not available in EPUB format,

     

       
21
       
+
       
            please use the <link xlink:href="https://nixos.org/nixpkgs/manual">HTML manual</link>

     

       
22
       
+
       
            instead.

     

       
23
       
+
       
          </para>

     

       
24
       
+
       
          <para>

     

       
25
       
+
       
            If you've used the EPUB manual in the past and it has been useful to you, please

     

       
26
       
+
       
            <link xlink:href="https://github.com/NixOS/nixpkgs/issues/237234">let us know</link>.

     

       
27
       
+
       
          </para>

     

       
28
       
+
       
        </chapter>

     

       
29
       
+
       
      </book>

     

       
30
       
+
       
    '';

     

       
31
       
+
       


     

       
32
       
+
       
    passAsFile = [ "epub" ];

     

       
33
       
+
       
  } ''

     

       
34
       
+
       
    mkdir scratch

     

       
35
       
+
       
    xsltproc \

     

       
36
       
+
       
      --param chapter.autolabel 0 \

     

       
37
       
+
       
      --nonet \

     

       
38
       
+
       
      --output scratch/ \

     

       
39
       
+
       
      ${pkgs.docbook_xsl_ns}/xml/xsl/docbook/epub/docbook.xsl \

     

       
40
       
+
       
      $epubPath

     

       
41
       
+
       


     

       
42
       
+
       
    echo "application/epub+zip" > mimetype

     

       
43
       
+
       
    zip -0Xq "$out" mimetype

     

       
44
       
+
       
    cd scratch && zip -Xr9D "$out" *

     

       
45
       
+
       
  '';

     

       
46
       
 
       
in pkgs.stdenv.mkDerivation {

     

       
47
       
 
       
  name = "nixpkgs-manual";

     

       
48
       
 
       


     
···

       
62
       
 
       
    ln -s ${doc-support} ./doc-support/result

     

       
63
       
 
       
  '';

     

       
64
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
65
       
 
       
  preBuild = ''

     

       
0
       
 
       

     

       
66
       
 
       
    make -j$NIX_BUILD_CORES render-md

     

       
67
       
 
       
  '';

     

       
68
       
 
       


     
···

       
72
       
 
       
    mv out/html "$dest"

     

       
73
       
 
       
    mv "$dest/index.html" "$dest/manual.html"

     

       
74
       
 
       


     

       
75
       
+
       
    cp ${epub} "$dest/nixpkgs-manual.epub"

     

       
76
       
 
       


     

       
77
       
 
       
    mkdir -p $out/nix-support/

     

       
78
       
 
       
    echo "doc manual $dest manual.html" >> $out/nix-support/hydra-build-products