about summary refs log tree commit diff
path: root/doc/default.nix
blob: 86b4a8d978146d23eda211a6cf4bf5b5c5c29443 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{ pkgs ? (import ./.. { }), nixpkgs ? { }}:
let
  doc-support = import ./doc-support { inherit pkgs nixpkgs; };
in pkgs.stdenv.mkDerivation {
  name = "nixpkgs-manual";

  nativeBuildInputs = with pkgs; [
    pandoc
    graphviz
    libxml2
    libxslt
    zip
    jing
    xmlformat
  ];

  src = pkgs.nix-gitignore.gitignoreSource [] ./.;

  postPatch = ''
    ln -s ${doc-support} ./doc-support/result
  '';

  epub = ''
    <book xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          version="5.0"
          xml:id="nixpkgs-manual">
      <info>
        <title>Nixpkgs Manual</title>
        <subtitle>Version ${pkgs.lib.version}</subtitle>
      </info>
      <chapter>
        <title>Temporarily unavailable</title>
        <para>
          The Nixpkgs manual is currently not available in EPUB format,
          please use the <link xlink:href="https://nixos.org/nixpkgs/manual">HTML manual</link>
          instead.
        </para>
        <para>
          If you've used the EPUB manual in the past and it has been useful to you, please
          <link xlink:href="https://github.com/NixOS/nixpkgs/issues/237234">let us know</link>.
        </para>
      </chapter>
    </book>
  '';
  passAsFile = [ "epub" ];

  preBuild = ''
    cp $epubPath epub.xml
    make -j$NIX_BUILD_CORES render-md
  '';

  installPhase = ''
    dest="$out/share/doc/nixpkgs"
    mkdir -p "$(dirname "$dest")"
    mv out/html "$dest"
    mv "$dest/index.html" "$dest/manual.html"

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

    mkdir -p $out/nix-support/
    echo "doc manual $dest manual.html" >> $out/nix-support/hydra-build-products
    echo "doc manual $dest nixpkgs-manual.epub" >> $out/nix-support/hydra-build-products
  '';

  # Environment variables
  PANDOC_LUA_FILTERS_DIR = "${pkgs.pandoc-lua-filters}/share/pandoc/filters";
  PANDOC_LINK_MANPAGES_FILTER = import build-aux/pandoc-filters/link-manpages.nix { inherit pkgs; };
}